Downloads:
6,945
Downloads of v 0.8.1.0:
6,514
Last Update:
26 Jan 2016
Package Maintainer(s):
Software Author(s):
- ACMESharp
Tags:
pki ssl tls security certificates letsencrypt acme powershell acmesharpACMESharp PowerShell Module - ALL (Install)
- 1
- 2
- 3
0.8.1.0 | Updated: 26 Jan 2016
Downloads:
6,945
Downloads of v 0.8.1.0:
6,514
Maintainer(s):
Software Author(s):
- ACMESharp
ACMESharp PowerShell Module - ALL (Install) 0.8.1.0
Legal Disclaimer: Neither this package nor Chocolatey Software, Inc. are affiliated with or endorsed by ACMESharp. The inclusion of ACMESharp trademark(s), if any, upon this webpage is solely to identify ACMESharp goods or services and not for commercial purposes.
- 1
- 2
- 3
Some Checks Have Failed or Are Not Yet Complete
Not All Tests Have Passed
Deployment Method: Individual Install, Upgrade, & Uninstall
To install ACMESharp PowerShell Module - ALL (Install), run the following command from the command line or from PowerShell:
To upgrade ACMESharp PowerShell Module - ALL (Install), run the following command from the command line or from PowerShell:
To uninstall ACMESharp PowerShell Module - ALL (Install), run the following command from the command line or from PowerShell:
Deployment Method:
This applies to both open source and commercial editions of Chocolatey.
1. Enter Your Internal Repository Url
(this should look similar to https://community.chocolatey.org/api/v2/)
2. Setup Your Environment
1. Ensure you are set for organizational deployment
Please see the organizational deployment guide
2. Get the package into your environment
Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)-
Open Source or Commercial:
- Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
- You can also just download the package and push it to a repository Download
-
Open Source
-
Download the package:
Download - Follow manual internalization instructions
-
-
Package Internalizer (C4B)
-
Run: (additional options)
choco download acmesharp-posh-all --internalize --source=https://community.chocolatey.org/api/v2/
-
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'"
- Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade acmesharp-posh-all -y --source="'INTERNAL REPO URL'" [other options]
See options you can pass to upgrade.
See best practices for scripting.
Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.
If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:
choco upgrade acmesharp-posh-all -y --source="'INTERNAL REPO URL'"
$exitCode = $LASTEXITCODE
Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
Exit 0
}
Exit $exitCode
- name: Install acmesharp-posh-all
win_chocolatey:
name: acmesharp-posh-all
version: '0.8.1.0'
source: INTERNAL REPO URL
state: present
See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.
chocolatey_package 'acmesharp-posh-all' do
action :install
source 'INTERNAL REPO URL'
version '0.8.1.0'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller acmesharp-posh-all
{
Name = "acmesharp-posh-all"
Version = "0.8.1.0"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'acmesharp-posh-all':
ensure => '0.8.1.0',
provider => 'chocolatey',
source => 'INTERNAL REPO URL',
}
Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.
4. If applicable - Chocolatey configuration/installation
See infrastructure management matrix for Chocolatey configuration elements and examples.
This package was approved by moderator ferventcoder on 26 Jan 2016.
ACMESharp is a .NET library and PowerShell client for the ACME protocol, which is used to interopertate with the Let's Encrypt project's CA server and any other ACME-compliant server.
This package installs the PowerShell module client to allow requesting and retrieving PKI certificates (X.509 SSL/TLS) from an ACME-compatible CA server. If you install this package with elevated privileges, the module will be installed to the system-wide PS modules directory. Otherwise, it will be installed to the installing user's personal PS modules directory.
Please Note: This package has the following installation requirements:
* minimum of Windows 2008R2
* minimum of PowerShell v3
* minimum of .NET Framework 4.5
ACMESharp implements an extensible provider model for various parts of its operation, including:
* Vault - handles storage of client-side state and artifacts
* Challenge Types and Challenge Handlers** - used to verify domain ownership to the CA
* PKI - handle PKI-related operations such as generating private keys and CSRs
* Installers - install issued PKI certificates to target servers
This package includes the base ACMESharp PowerShell module and all official ACMESharp extension Providers which include:
* manual
- DNS and HTTP Challenge Handler
* iis
- HTTP Challenge Handler for local Windows IIS server
* awsRoute53
- DNS Challenge Handler for AWS Route 53 service
* awsS3
- HTTP Challenge Handler for AWS S3 service in combination with CloudFront front-end
This package currently includes no automated installers, therefore you need to manually install the generated certificates by exporting them first into an appropriate format.
#cd C:\prj\letsencrypt\solutions\letsencrypt-win\letsencrypt-win\LetsEncrypt.ACME.POSH
#Add-Type -Path .\bin\Debug\ACMESharp.POSH.dll
<#
Configure/install certs
Install-ACMECertificateToAWS -Ref <cert-ref>
-IAMPath <path> - optional, prefix with /cloudfront/ to use with CloudFront
-IAMName <path> - required
-ELBName <elb-name> - optional to install on ELB
-ELBPort <elb-port> - required if elb-name is specified
-VaultProfile <vp>
#>
## We need the AWS POSH Module
Import-Module AWSPowerShell
## TODO: We'll need to either "assume" that the user has
## already imported the module or explicitly re-import it
## and we'll also have to address the Default Noun Prefix
##Import-Module ACMESharp
function Install-CertificateToAWS {
param(
[Parameter(Mandatory=$true)]
[string]$Certificate,
[Parameter(Mandatory=$true)]
[string]$IAMName,
[string]$IAMPath,
[switch]$UseWithCloudFront,
[switch]$IAMReplace,
[string]$ELBName,
[int]$ELBPort,
## AWS POSH Base Params
[object]$Region,
[string]$AccessKey,
[string]$SecretKey,
[string]$SessionToken,
[string]$ProfileName,
[string]$ProfilesLocation,
[Amazon.Runtime.AWSCredentials]$Credentials
)
$vpParams = @{}
if ($VaultProfile) {
$vpParams.VaultProfile = $VaultProfile
}
## This switch is just a flag that we need to check for the IAM Server
## Certificate path to match some specific naming convention
if ($UseWithCloudFront) {
if (-not $IAMPath.StartsWith('/cloudfront/')) {
throw "IAM Server Certificate path must start with '/cloudfront/' to use with CloudFront"
}
}
$ci = Get-ACMECertificate @vpParams -Ref $Certificate
if ($ci.IssuerSerialNumber) {
$ic = Get-ACMEIssuerCertificate @vpParams -SerialNumber $ci.IssuerSerialNumber
if ($ic) {
if (-not $ic.CrtPemFile) {
throw "Unable to resolve Issuer Certificate PEM file"
}
}
}
if (-not $ci.KeyPemFile) {
throw "Unable to resolve Private Key PEM file"
}
if (-not $ci.CrtPemFile) {
throw "Unable to resolve Certificate PEM file"
}
$privKeyFile = [System.IO.Path]::GetTempFileName()
$certBodyFile = [System.IO.Path]::GetTempFileName()
Get-ACMECertificate @vpParams -Ref $Certificate `
-ExportKeyPEM $privKeyFile `
-ExportCertificatePEM $certBodyFile
$privKey = [System.IO.File]::ReadAllText($privKeyFile)
$certBody = [System.IO.File]::ReadAllText($certBodyFile)
if ($ic) {
$certChainFile = [System.IO.Path]::GetTempFileName()
Get-ACMEIssuerCertificate @vpParams -ExportCertificatePEM $certChainFile
$certChain = [System.IO.File]::ReadAllText($certChainFile)
del $certChainFile
}
del $privKeyFile
del $certBodyFile
## Assemble AWS POSH Base Args to pass along for authentication
$awsBaseArgs = @{
Region = $Region
AccessKey = $AccessKey
SecretKey = $SecretKey
SessionToken = $SessionToken
ProfileName = $ProfileName
ProfilesLocation = $ProfilesLocation
Credentials = $Credentials
}
## -Certificate 1 -Verbose -ProfileName auto@aws3 -IAMName le1
## -Certificate 1 -Verbose -ProfileName auto@aws3 -IAMName le2 -ELBName foo
## -Certificate 1 -Verbose -ProfileName auto@aws3 -IAMName le2 -ELBName foo -ELBPort 8443 -Region us-east-1
## -Certificate 1 -Verbose -ProfileName auto@aws3 -IAMName le2 -ELBName STAGE-PP-MTB -ELBPort 8443 -Region us-east-1
$awsCert = $null
$awsCertMeta = $null
if ($IAMName) {
try {
## See if a cert for that name already exists
$awsCert = Get-IAMServerCertificate -ServerCertificateName $IAMName -ErrorAction Ignore @awsBaseArgs
if ($awsCert) {
$awsCertMeta = $awsCert.ServerCertificateMetadata
}
} catch { }
if ($awsCertMeta) {
if ($IAMReplace) {
Remove-IAMServerCertificate -ServerCertificateName $IAMName -Force @awsBaseArgs
$awsCert = $null
$awsCertMeta = $null
}
elseif ($awsCert.CertificateBody.Trim() -ne $certBody.Trim()) {
throw "Non-matching certificate already installed under referenced Server Certificate Name"
}
else {
Write-Verbose "Matching certificate already installed under referenced Server Certificate Name"
}
}
if (-not $awsCertMeta -or $IAMReplace) {
$apiArgs = @{
PrivateKey = $privKey
CertificateBody = $certBody
CertificateChain = $certChain
ServerCertificateName = $IAMName
}
if ($IAMPath) {
$apiArgs.Path = $IAMPath
}
$awsCertMeta = Publish-IAMServerCertificate @apiArgs @awsBaseArgs
}
}
if ($ELBName) {
if (-not $ELBPort -or $ELBPort -lt 1) {
throw "Invalid or missing ELB port"
}
$apiArgs = @{
LoadBalancerName = $ELBName
LoadBalancerPort = $ELBPort
SSLCertificateId = $awsCertMeta.Arn
}
echo "SSLCertificate = $($awsCert)"
echo "SSLCertificateM = $($awsCertMeta)"
echo "SSLCertificateId = $($awsCertMeta.Arn)"
Set-ELBLoadBalancerListenerSSLCertificate @apiArgs @awsBaseArgs
}
}
Export-ModuleMember -Function Install-CertificateToAWS
#cd C:\prj\letsencrypt\solutions\letsencrypt-win\letsencrypt-win\ACMESharp.POSH
#Add-Type -Path .\bin\Debug\ACMESharp.POSH.dll
<#
Configure/install certs
Install-ACMECertificateToIIS -Ref <cert-ref>
-ComputerName <target-server> - optional (defaults to local)
-Website <website-name> - optional (defaults to 'Default Web Site')
-HostHeader <hostheader-name> - optional (defaults to none)
-IPAddress <ip-address> - optional (defaults to all)
-Port <port-num> - optional (defaults to 443)
-VaultProfile <vp>
#>
function Install-CertificateToIIS {
param(
[Parameter(Mandatory=$true)]
[string]$Certificate,
[string]$WebSite = "Default Web Site",
[string]$IPAddress,
[int]$Port,
[string]$SNIHostname,
[switch]$SNIRequired,
[switch]$Replace,
[string]$VaultProfile,
[System.Management.Automation.Runspaces.PSSession]$RemoteSession
)
## TODO: We'll need to either "assume" that the user has
## already imported the module or explicitly re-import it
## and we'll also have to address the Default Noun Prefix
##Import-Module ACMESharp
$vpParams = @{}
if ($VaultProfile) {
$vpParams.VaultProfile = $VaultProfile
}
$ci = Get-ACMECertificate @vpParams -Ref $Certificate
if ($ci.IssuerSerialNumber) {
$ic = Get-ACMEIssuerCertificate @vpParams -SerialNumber $ci.IssuerSerialNumber
if ($ic) {
if (-not $ic.CrtPemFile) {
throw "Unable to resolve Issuer Certificate PEM file $($ci.IssuerSerialNumber)"
}
}
}
if (-not $ci.KeyPemFile) {
throw "Unable to resolve Private Key PEM file"
}
if (-not $ci.CrtPemFile) {
throw "Unable to resolve Certificate PEM file"
}
## Export out the PFX to a local temp file
$pfxTemp = [System.IO.Path]::GetTempFileName()
$crt = Get-ACMECertificate @vpParams -Ref $Certificate -ExportPkcs12 $pfxTemp -Overwrite
if (-not $crt.Thumbprint) {
throw "Unable to resolve certificate Thumbprint"
}
## Assemble a number of arguments and
## settings based on input parameters
$webBindingArgs = @{
Name = $WebSite
Protocol = "https"
}
$sslBinding = @{
Host = "0.0.0.0"
Port = "443"
}
if ($IPAddress) {
$webBindingArgs.IPAddress = $IPAddress
$sslBinding.Host = $IPAddress
}
if ($Port) {
$webBindingArgs.Port = $Port
$sslBinding.Port = "$Port"
}
if ($SNIHostname) {
$webBindingArgs.HostHeader = $SNIHostname
}
## We craft a ScriptBlock to do the real work in such a way that we can invoke
## it locally or remotely based on the right combination of input parameters
[scriptblock]$script = {
param(
[string]$CrtThumbprint,
[string]$pfxTemp,
[byte[]]$pfxBytes,
[bool]$SNIRequired,
[bool]$Replace,
[hashtable]$webBindingArgs,
[hashtable]$sslBinding
)
Write-Warning "Params:"
Write-Warning " * $CrtThumbprint"
Write-Warning " * $pfxTemp"
Write-Warning " * $($pfxBytes.Length)"
Write-Warning " * $SNIRequired"
Write-Warning " * $Replace"
Write-Warning " * $webBindingArgs"
Write-Warning " * $sslBinding"
## If we're running locally, then the PFX temp file already exists
## If we're running remotely, we need to save the PFX bytes to a temp file
if ($pfxBytes) {
if (-not $pfxTemp) {
$pfxTemp = [System.IO.Path]::GetTempFileName()
}
[System.IO.File]::WriteAllBytes($pfxTemp, $pfxBytes);
Write-Verbose "Exported PFX bytes to temp file [$pfxTemp]"
}
## Import the PFX file to the local machine store and make sure its there
## NOTE: instead of using the native PKI Cert path provider and cmdlets, we're using the
## .NET framework directly because it will work on older platforms (Win2008, PS3)
$crtStore = new-object System.Security.Cryptography.X509Certificates.X509Store "My","LocalMachine"
$crtBytes = [System.IO.File]::ReadAllBytes($pfxTemp)
$crt = new-object System.Security.Cryptography.X509Certificates.X509Certificate2
$crt.Import($crtBytes, $null, "Exportable,PersistKeySet”)
Write-Verbose "Using certificate [$($crt.Thumbprint)]"
$crtStore.Open("MaxAllowed")
$exists = $crtStore.Certificates | ? { $_.Thumbprint -eq $crt.Thumbprint }
if (-not $exists) {
Write-Verbose "Importing certificate from PFX [$pfxTemp]"
$crtStore.Add($crt)
$exists = $crtStore.Certificates | ? { $_.Thumbprint -eq $crt.Thumbprint }
if (-not $exists) {
throw "Failed to import Certificate or import was misplaced"
}
}
else {
Write-Verbose "Existing certificate with matching Thumbprint found; SKIPPING"
}
$crtStore.Close()
## This is used later on for creating the SSL Binding
$crtPath = "Cert:\LocalMachine\My\$($CrtThumbprint)"
if (Test-Path $pfxTemp) {
del $pfxTemp
}
## We need the MS Web Admin Module
Import-Module WebAdministration
## General guidelines for this procedure were borrowed from:
## http://www.iis.net/learn/manage/powershell/powershell-snap-in-configuring-ssl-with-the-iis-powershell-snap-in
## See if there is already a matching Web Binding
Write-Verbose "Testing for existing Web Binding"
$existingWebBinding = Get-WebBinding @webBindingArgs
if ($existingWebBinding) {
Write-Warning "Existing Web Binding found matching specified parameters; SKIPPING"
}
else {
$webBindingCreateArgs = @{}
if ($SNIRequired) {
$webBindingCreateArgs.SslFlags = 1
}
Write-Verbose "Creating Web Binding..."
New-WebBinding @webBindingArgs @webBindingCreateArgs
$newWebBinding = Get-WebBinding @webBindingArgs
if (-not $newWebBinding) {
throw "Failed to create new Web Binding"
}
Write-Verbose "Web Binding was created"
}
## See if there is already a matching SSL Binding
Write-Verbose "Testing for existing SSL Binding"
$sslBindingPath = "IIS:\SslBindings\$($sslBinding.Host)!$($sslBinding.Port)"
Write-Verbose " ...testing for [$sslBindingPath]"
if (Test-Path -Path $sslBindingPath) {
if ($Replace) {
Write-Warning "Deleting existing SSL Binding";
Remove-Item $sslBindingPath
}
else {
throw "Existing SSL Binding found"
}
}
Write-Verbose "Creating SSL Binding..."
Write-Verbose " ...at path [$sslBindingPath]"
Get-Item $crtPath | New-Item $sslBindingPath
$newSslBinding = Get-Item $sslBindingPath
if (-not $newSslBinding) {
throw "Failed to create new SSL Binding"
}
Write-Verbose "SSL Binding was created"
}
if ($RemoteSession)
{
$pfxBytes = [System.IO.File]::ReadAllBytes($pfxTemp);
$invArgs = @(
,$ci.Thumbprint
,$null ## $pfxTemp
,$pfxBytes
,$SNIRequired.IsPresent
,$Replace.IsPresent
,$webBindingArgs
,$sslBinding
)
Invoke-Command -Session $RemoteSession -ArgumentList $invArgs -ScriptBlock $script
}
else {
$invArgs = @(
,$ci.Thumbprint
,$pfxTemp
,$null ## $pfxBytes
,$SNIRequired.IsPresent
,$Replace.IsPresent
,$webBindingArgs
,$sslBinding
)
$script.Invoke($invArgs)
}
## Delete the local PFX temp file
if (Test-Path $pfxTemp) {
del $pfxTemp
}
}
Export-ModuleMember -Function Install-CertificateToIIS
md5: EA583D990BEFCAEA56230805CF22DED5 | sha1: B04E3063571E5356DFA8FB0FD9266CBBB43EE1D5 | sha256: 8F904A54ED0C07962E585FC065E6AB273B399980BBF65CA2950842AB93EE356A | sha512: F6B892AA42BF89A9AF957F48D5B5E5F8CE7BE3E07058A2E3B2C82FC33B76F0845F5DD676829BDB9199B07FB72B8BBC767444EC22E8EBA3027B129B00E66EBD28
md5: BC8F793BC899A29F03B9DF10C68E15A6 | sha1: 030D42385D251FB5367F4F8E682A328ADE64FCBE | sha256: 933E4C325601BAE82650B7A28B45BC2EE48DBAAF604D2E2058E636128B419B2F | sha512: E7EEEC1D6844AAFFBEA3DF073A2B14F55044BD04E486FDA893E1185731C8E23BA029C2661A6D141B8B97D7C0F09A46CA183E8E78FE4C8F137D2EAED396F00A16
md5: 12B8B59ECB7109D1EAECF7DF69475350 | sha1: CED5C5654A1EE8D6A977EFC858A80F6173C34D80 | sha256: 5E7C1AA017E6ED398D664BA5E91BF10E23482471B0997D385F4E44F308DAEFF8 | sha512: 3DDD99F4152E3F2717139FD7FCB44681C47ED0550BB394202C4851EC0A036CBAAD41D090B8A16C8FD3B8E5D50C8CB5694A4A4702E8C4513497E88E7C4B8602C6
md5: AF427A075199F57A93463EF99155C94D | sha1: 76D671E0A51250BC95513514E916630198AC8F88 | sha256: 39B8327CE79DC2DEA4235F3CC2A58375360C4D5A189739DCA845CD330AF329D0 | sha512: D263EECE8186BC8F18B6FD92E43F63E84374C778ED883224CC57A6732153F609A825803338983A078814B54C901E0C6699676FB6766B0556F9CCEE4F000F3DF2
md5: 96C9C89737F450140A6C58131122DD51 | sha1: D78D495F0AA987F0CE7730A4ADBA4F718B89AA2B | sha256: CF09C2F569715956C43615A4EAD87AEA7AB14327A36C7B5EE3B25DBA45B915C3 | sha512: 2A1DBD88742E5BFEB9C7AF0A880AD84A7CD360462029B8203166FECF77F989690716E453837125A0163BF5A615DEF3A02CC2540D9E750C90F7A21C1FDDFAE089
<?xml version="1.0"?>
<doc>
<assembly>
<name>ACMESharp.POSH</name>
</assembly>
<members>
<member name="T:ACMESharp.POSH.GetCertificate">
<summary>
<para type="synopsis">
Gets the status and details of a Certificate stored in the Vault.
</para>
<para type="description">
This cmdlet retrieves the details of a Certificate defined in the Vault.
It is also used to export various artificates associated with the Certificate
to various formats.
</para>
<para type="link">New-Certificate</para>
<para type="link">Submit-Certificate</para>
<para type="link">Update-Certificate</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.GetCertificate.CertificateRef">
<summary>
<para type="description">
A reference (ID or alias) to a previously defined Certificate request.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.GetCertificate.ExportKeyPEM">
<summary>
<para type="description">
Optionally, specifies a file path where the private key associated
with the referenced Certificate will be saved in PEM format.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.GetCertificate.ExportCsrPEM">
<summary>
<para type="description">
Optionally, specifies a file path where the CSR associated
with the referenced Certificate will be saved in PEM format.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.GetCertificate.ExportCertificatePEM">
<summary>
<para type="description">
Optionally, specifies a file path where the referenced Certificate
will be saved in PEM format.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.GetCertificate.ExportCertificateDER">
<summary>
<para type="description">
Optionally, specifies a file path where the referenced Certificate
will be saved in DER format.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.GetCertificate.ExportIssuerPEM">
<summary>
<para type="description">
Optionally, specifies a file path where the referenced Issuer
Certificate will be saved in PEM format.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.GetCertificate.ExportIssuerDER">
<summary>
<para type="description">
Optionally, specifies a file path where the referenced Issuer
Certificate will be saved in DER format.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.GetCertificate.ExportPkcs12">
<summary>
<para type="description">
Optionally, specifies a file path where the referenced Certificate
and related artifacts will be saved into a PKCS#12 archive format.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.GetCertificate.CertificatePassword">
<summary>
<para type="description">
Optionally, specifies a password to use to secure an exported
PKCS#12 archive file.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.GetCertificate.Overwrite">
<summary>
<para type="description">
This flag indicates that any existing files matching any of the
requested export parameter paths will be overwritten. If not
specified, existing files will cause this cmdlet to error.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.GetCertificate.VaultProfile">
<summary>
<para type="description">
Specifies a Vault profile name that will resolve to the Vault instance to be
used for all related operations and storage/retrieval of all related assets.
</para>
</summary>
</member>
<member name="T:ACMESharp.POSH.GetIdentifier">
<summary>
<para type="synopsis">Lists all, or retrieves details for, Identifiers submitted for
verification.</para>
<para type="description">
Use this cmdlet to list all of the Identifier that have been previously
defined and submitted to the ACME CA Server of the current Vault. You
also use this cmdlet to specify specific Identifier references (ID or alias)
to retrieve more specific details as they are captured in the Vault.
</para>
<para type="link">New-Identifier</para>
<para type="link">Update-Identifier</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.GetIdentifier.IdentifierRef">
<summary>
<para type="description">
A reference (ID or alias) to a previously defined Identifier submitted
to the ACME CA Server for verification.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.GetIdentifier.VaultProfile">
<summary>
<para type="description">
Specifies a Vault profile name that will resolve to the Vault instance to be
used for all related operations and storage/retrieval of all related assets.
</para>
</summary>
</member>
<member name="T:ACMESharp.POSH.CompleteChallenge">
<summary>
<para type="synopsis">Completes a Challenge using a prescribed Handler.</para>
<para type="description">
Use this cmdlet to complete a Challenge associated with an Identifier
defined in an ACMESharp Vault that has been submitted for verification
to an ACME CA Server.
</para>
<para type="link">Get-ChallengeHandlerProfile</para>
<para type="link">Set-ChallengeHandlerProfile</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.CompleteChallenge.IdentifierRef">
<summary>
<para type="description">
A reference (ID or alias) to a previously defined Identifier submitted
to the ACME CA Server for verification.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.CompleteChallenge.HandlerProfileRef">
<summary>
<para type="description">
Specifies a reference (ID or alias) to a previously defined Challenge
Handler profile in the associated Vault that defines the Handler
provider and associated instance parameters that should be used to
resolve the Challenge.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.CompleteChallenge.ChallengeType">
<summary>
<para type="description">
Specifies the ACME Challenge type that should be handled. This type
is expected to be found in the list of Challenges returned by the
ACME CA Server for the associated Identifier.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.CompleteChallenge.Handler">
<summary>
<para type="description">
Specifies the Challenge Handler instance provider that will be used to
handle the associated Challenge.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.CompleteChallenge.HandlerParameters">
<summary>
<para type="description">
Specifies the parameters that will be passed to the Challenge Handler
instance that will be used to handle the associated Challenge.
</para>
<para type="description">
If this cmdlet is invoked *in-line*, then these are the only parameters
that will be passed to the handler. If this cmdlet is invoked with a
handler profile reference, then these parameters are merged with, and
override, whatever parameters are already defined within the profile.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.CompleteChallenge.CleanUp">
<summary>
<para type="description">
When specified, executes the <i>clean up</i> operation associated with
the resolved Challenge Handler. This is typcially invoked after the
challenge has been previously successfully completed and submitted to
the ACME server, and is used to remove any residual resources or traces
of the steps that were needed during the challenge-handling process.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.CompleteChallenge.Regenerate">
<summary>
<para type="description">
When specified, will force the decoding and regeneration of any ACME-defined
heuristics and parameters for the given Challenge type.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.CompleteChallenge.Repeat">
<summary>
<para type="description">
When specified, forces the resolved Handler to repeat the process of
handling the given Challenge, even if the process has already been
completed previously.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.CompleteChallenge.UseBaseUri">
<summary>
<para type="description">
Overrides the base URI associated with the target Registration and used
for subsequent communication with the associated ACME CA Server.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.CompleteChallenge.VaultProfile">
<summary>
<para type="description">
Specifies a Vault profile name that will resolve to the Vault instance to be
used for all related operations and storage/retrieval of all related assets.
</para>
</summary>
</member>
<!-- Badly formed XML comment ignored for member "T:ACMESharp.POSH.NewCertificate" -->
<member name="P:ACMESharp.POSH.NewCertificate.IdentifierRef">
<summary>
<para type="description">
A reference (ID or alias) to a previously defined and authorized
Identifier verified by the ACME CA Server.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.NewCertificate.KeyPemFile">
<summary>
<para type="description">
Specifies an existing private key in PEM file format that should be
used to generate the Certificate Request.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.NewCertificate.CsrPemFile">
<summary>
<para type="description">
Specifies an existing CSR in PEM file format containing all the
details of the Certificate that should be used to generate the
Certificate Request.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.NewCertificate.Generate">
<summary>
<para type="description">
Indicates that new Certificate Request parameters and artificats
should be generated.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.NewCertificate.CsrDetails">
<summary>
<para type="description">
An optional set of certificate details to be included in the
generated CSR.
</para>
<para type="description">
The common name will be set based on the DNS name of the associated
Identifier, however all other details will be specified as set in
this parameter. The following elements are defined, however not all
of these may be supported or honored by the target ACME CA Server:
* Country; // C;
* StateOrProvince; // ST;
* Locality; // L;
* Organization; // O;
* OrganizationUnit; // OU;
* Description; // D;
* Surname; // S;
* GivenName; // G;
* Initials; // I;
* Title; // T;
* SerialNumber; // SN;
* UniqueIdentifier; // UID;
* AlternativeNames; // X509 SAN Extension (manually overridden)
</para>
<para type="description">
For any elements that except multiple values (such as SAN), specify
a string of values separated by space, comma or semicolon
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.NewCertificate.AlternativeIdentifierRefs">
<summary>
<para type="description">
A collection of one or more references (ID or alias) to previously
defined and authorized Identifiers verified by the ACME CA Server
which will be included in the X509 extension for the list of
Subject Alternative Names (SAN).
</para>
<para type="description">
There is no need to repeat the reference to the primary common name
Identifier as it will be automatically included at the start of this list.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.NewCertificate.Alias">
<summary>
<para type="description">
An optional, unique alias to assign to the Certificate for future
reference.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.NewCertificate.Label">
<summary>
<para type="description">
An optional, human-friendly label to assign to the Certificate for
easy recognition.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.NewCertificate.Memo">
<summary>
<para type="description">
An optional, arbitrary text field to capture any notes or details
associated with the Certificate.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.NewCertificate.VaultProfile">
<summary>
<para type="description">
Specifies a Vault profile name that will resolve to the Vault instance to be
used for all related operations and storage/retrieval of all related assets.
</para>
</summary>
</member>
<member name="T:ACMESharp.POSH.NewIdentifier">
<summary>
<para type="synopsis">
Creates and submits a new Identifier to be verified to the ACME CA Server.
</para>
<para type="description">
Currently, the only Identifier type supported is the DNS type.
</para>
<para type="link">Get-Identifier</para>
<para type="link">Update-Identifier</para>
<para type="link">Complete-Challenge</para>
<para type="link">Submit-Challenge</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.NewIdentifier.Dns">
<summary>
<para type="description">
Specifies the DNS name to be submitted for verification.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.NewIdentifier.Alias">
<summary>
<para type="description">
An optional, unique alias to assign to the Identifier for future
reference.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.NewIdentifier.Label">
<summary>
<para type="description">
An optional, human-friendly label to assign to the Identifier for
easy recognition.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.NewIdentifier.Memo">
<summary>
<para type="description">
An optional, arbitrary text field to capture any notes or details
associated with the Identifier.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.NewIdentifier.VaultProfile">
<summary>
<para type="description">
Specifies a Vault profile name that will resolve to the Vault instance to be
used for all related operations and storage/retrieval of all related assets.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.SubmitCertificate.CertificateRef">
<summary>
<para type="description">
A reference (ID or alias) to a previously defined Certificate request.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.SubmitCertificate.VaultProfile">
<summary>
<para type="description">
Specifies a Vault profile name that will resolve to the Vault instance to be
used for all related operations and storage/retrieval of all related assets.
</para>
</summary>
</member>
<!-- Badly formed XML comment ignored for member "T:ACMESharp.POSH.SubmitChallenge" -->
<member name="P:ACMESharp.POSH.SubmitChallenge.IdentifierRef">
<summary>
<para type="description">
A reference (ID or alias) to a previously defined Identifier submitted
to the ACME CA Server for verification.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.SubmitChallenge.ChallengeType">
<summary>
<para type="description">
Specifies the ACME Challenge type that should be submitted. This type
is expected to be found in the list of Challenges returned by the
ACME CA Server for the associated Identifier and it should already have
been handled previously, either externally to the ACMESharp operations
or via the Handler mechanisms within.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.SubmitChallenge.UseBaseUri">
<summary>
<para type="description">
Overrides the base URI associated with the target Registration and used
for subsequent communication with the associated ACME CA Server.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.SubmitChallenge.VaultProfile">
<summary>
<para type="description">
Specifies a Vault profile name that will resolve to the Vault instance to be
used for all related operations and storage/retrieval of all related assets.
</para>
</summary>
</member>
<member name="T:ACMESharp.POSH.UpdateCertificate">
<summary>
<para type="synopsis">
Updates the status and details of a Certificate stored in the Vault.
</para>
<para type="description">
Use this cmdlet to update characteristics of an Identifier that are
defined locally, such as the Alias or Label.
</para>
<para type="description">
Also use this cmdlet to refresh the state and status of a Certificate
including retrieving the certificate and intermediate signing certificate
from the associated ACME CA Server.
</para>
<para type="link">New-Certificate</para>
<para type="link">Get-Certificate</para>
<para type="link">Submit-Certificate</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateCertificate.CertificateRef">
<summary>
<para type="description">
A reference (ID or alias) to a previously defined Certificate request.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateCertificate.UseBaseUri">
<summary>
<para type="description">
Overrides the base URI associated with the target Registration and used
for subsequent communication with the associated ACME CA Server.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateCertificate.Repeat">
<summary>
<para type="description">
When specified, this flag instructs the cmdlet to repeat the retrieval of
the issued certificate and related artifacts (e.g. intermediate signing cert).
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateCertificate.LocalOnly">
<summary>
<para type="description">
Indicates that updates should be performed locally only, and no attempt
should be made to retrieve the current status from the ACME CA Server.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateCertificate.Alias">
<summary>
<para type="description">
Optionaly, set or update the unique alias assigned to the Certificate
for future reference.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateCertificate.Label">
<summary>
<para type="description">
Optionally, set or update the human-friendly label to assigned to the
Certificate for easy recognition.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateCertificate.Memo">
<summary>
<para type="description">
Optionall, set or update the arbitrary text field used to capture any
notes or details associated with the Certificate.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateCertificate.VaultProfile">
<summary>
<para type="description">
Specifies a Vault profile name that will resolve to the Vault instance to be
used for all related operations and storage/retrieval of all related assets.
</para>
</summary>
</member>
<member name="T:ACMESharp.POSH.UpdateIdentifier">
<summary>
<para type="synopsis">
Updates the status and details of an Identifier stored in the Vault.
</para>
<para type="description">
Use this cmdlet to update characteristics of an Identifier that are
defined locally, such as the Alias or Label.
</para>
<para type="description">
Also use this cmdlet to refresh the state and status of an Identifier
by probing the associated ACME CA Server for Identifier details.
</para>
<para type="link">New-Identifier</para>
<para type="link">Get-Identifier</para>
<para type="link">Complete-Challenge</para>
<para type="link">Submit-Challenge</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateIdentifier.IdentifierRef">
<summary>
<para type="description">
A reference (ID or alias) to a previously defined Identifier submitted
to the ACME CA Server for verification.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateIdentifier.ChallengeType">
<summary>
<para type="description">
Specifies the ACME Challenge type that should be updated.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateIdentifier.UseBaseUri">
<summary>
<para type="description">
Overrides the base URI associated with the target Registration and used
for subsequent communication with the associated ACME CA Server.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateIdentifier.LocalOnly">
<summary>
<para type="description">
Indicates that updates should be performed locally only, and no attempt
should be made to retrieve the current status from the ACME CA Server.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateIdentifier.Alias">
<summary>
<para type="description">
Optionaly, set or update the unique alias assigned to the Identifier
for future reference.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateIdentifier.Label">
<summary>
<para type="description">
Optionally, set or update the human-friendly label to assigned to the
Identifier for easy recognition.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateIdentifier.Memo">
<summary>
<para type="description">
Optionall, set or update the arbitrary text field used to capture any
notes or details associated with the Identifier.
</para>
</summary>
</member>
<member name="P:ACMESharp.POSH.UpdateIdentifier.VaultProfile">
<summary>
<para type="description">
Specifies a Vault profile name that will resolve to the Vault instance to be
used for all related operations and storage/retrieval of all related assets.
</para>
</summary>
</member>
<member name="M:ACMESharp.POSH.Util.PoshHelper.BeforeExtAccess">
<summary>
This routine must be invoked from any CMDLET that relies on the Ext
mechanism when running under POSH, but does not make use of Vault.
</summary>
</member>
<member name="F:ACMESharp.POSH.Util.PoshHelper.PROBLEM_DETAIL_TYPE_URN">
<summary>
Defines the well-defined ACME problem detail type URN prefix.
</summary>
</member>
<member name="F:ACMESharp.POSH.Util.PoshHelper.PROBLEM_DETAIL_TYPE_TO_ERROR_CATEGORY">
<summary>
Defines a mapping from well-defined ACME problem detail type URNs to
POSH <see cref="T:System.Management.Automation.ErrorCategory">error categories</see>.
</summary>
<remarks>
This list was compiled from: https://ietf-wg-acme.github.io/acme/#rfc.section.5.4
</remarks>
</member>
<member name="M:ACMESharp.POSH.Util.PoshHelper.CreateErrorRecord(ACMESharp.AcmeClient.AcmeWebException,System.Object)">
<summary>
Constructs an <see cref="T:System.Management.Automation.ErrorRecord"/> from an <see cref="T:ACMESharp.AcmeClient.AcmeWebException"/>,
populating as much detail as can be derived.
</summary>
<param name="ex"></param>
<param name="targetObject"></param>
<returns></returns>
</member>
</members>
</doc>
md5: 52D31816DCA546C2E09B3D8B25CF2A5F | sha1: 460DE4165CBFAB641A72D571B34611C20202863C | sha256: C3C691D91C74A8E33D1E01D611853A63FDC0F801C2D1300C16603A09FE128E0B | sha512: 162662E2149C901CFC198BEB46EF71C562A974DDFD1C4814EBF4368918ECBE5B83E98299B96F512DD80165A6757CD74586D2AA55625E2914420EA2FC272FC07A
md5: C76BD87BF9BFB470665B49F6985AA9CF | sha1: 4D87C271657D664C0B696EFDF1648F4E195B8F36 | sha256: B90438BA5DA03841B46F74F63D59A033D0D109E11BA6A7FAD4B3C7B8CBBBD8ED | sha512: B449EAF7EBF7423CC28DC91181978553774033BCAB22EDE8EE00C377C46F5081573C9FA8EF3144E8EC31DAEAD6D8B8A34321995801083334FF7B95E196CF9A05
md5: 03F53FA81626233F6739BF1B54B8624A | sha1: AE6E7D1042697E3F340785909529293B158E5F35 | sha256: C01346FC69F6E6E310C9C7239AB395B760DBEB5216DC0AA93F45E93330BB8CE2 | sha512: 4B4E219DD0F1FD0EFC2EFFE36164E26D4EB0642CFC358CE3169EC31F50D49A4B4A0B5FA3507B29E42BF492EC9463CF30798E7E6BF70C6F961C08D7468C0D9492
md5: E70CC8953B937E265BECE4A32795ACBA | sha1: 73939C8A37862B401AB92738ED170BC83A74F5CF | sha256: 86DF6095838C94C54FFCF12DF41F448F7BEBC90864601576F7E187C16B0FB0F4 | sha512: EE3F950756224D7758F4479AF29899148E6725B1BBB57C2BB0CA098F23348B8F7C021D722BE7D8B04E615287AB4A96004D8B7067BA67E80E7FA674B76483F261
<?xml version="1.0"?>
<doc>
<assembly>
<name>AWSSDK.Core</name>
</assembly>
<members>
<member name="T:Amazon.AWSConfigs">
<summary>
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.
<code>
<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>
</code>
</summary>
<summary>
Configuration options that apply to the entire SDK.
</summary>
</member>
<member name="P:Amazon.AWSConfigs.CorrectForClockSkew">
<summary>
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.
<seealso cref="P:Amazon.AWSConfigs.ClockOffset"/> will be updated with the calculated
offset even if this field is set to false, though requests
will not be corrected or retried.
</summary>
</member>
<member name="P:Amazon.AWSConfigs.ClockOffset">
<summary>
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 <seealso cref="P:Amazon.AWSConfigs.CorrectForClockSkew"/> 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.
</summary>
</member>
<member name="F:Amazon.AWSConfigs.AWSRegionKey">
<summary>
Key for the AWSRegion property.
<seealso cref="P:Amazon.AWSConfigs.AWSRegion"/>
</summary>
</member>
<member name="P:Amazon.AWSConfigs.AWSRegion">
<summary>
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:
<code>
<configSections>
<section name="aws" type="Amazon.AWSSection, AWSSDK"/>
</configSections>
<aws region="us-west-2" />
</code>
</summary>
</member>
<member name="F:Amazon.AWSConfigs.AWSProfileNameKey">
<summary>
Key for the AWSProfileName property.
<seealso cref="P:Amazon.AWSConfigs.AWSProfileName"/>
</summary>
</member>
<member name="P:Amazon.AWSConfigs.AWSProfileName">
<summary>
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.
<para>
To reference the account from an application's App.config or Web.config use the AWSProfileName setting.
<code>
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="development"/>
</appSettings>
</configuration>
</code>
</para>
</summary>
</member>
<member name="F:Amazon.AWSConfigs.AWSProfilesLocationKey">
<summary>
Key for the AWSProfilesLocation property.
<seealso cref="P:Amazon.AWSConfigs.LogMetrics"/>
</summary>
</member>
<member name="P:Amazon.AWSConfigs.AWSProfilesLocation">
<summary>
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.
<para>
To reference the profile from an application's App.config or Web.config use the AWSProfileName setting.
<code>
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfilesLocation" value="c:\config"/>
</appSettings>
</configuration>
</code>
</para>
</summary>
</member>
<member name="F:Amazon.AWSConfigs.LoggingKey">
<summary>
Key for the Logging property.
<seealso cref="P:Amazon.AWSConfigs.Logging"/>
</summary>
</member>
<member name="P:Amazon.AWSConfigs.Logging">
<summary>
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:
<code>
<appSettings>
<add key="AWSLogging" value="log4net"/>
</appSettings>
</code>
</summary>
</member>
<member name="F:Amazon.AWSConfigs.ResponseLoggingKey">
<summary>
Key for the ResponseLogging property.
<seealso cref="P:Amazon.AWSConfigs.ResponseLogging"/>
</summary>
</member>
<member name="P:Amazon.AWSConfigs.ResponseLogging">
<summary>
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:
<code>
<appSettings>
<add key="AWSResponseLogging" value="OnError"/>
</appSettings>
</code>
</summary>
</member>
<member name="F:Amazon.AWSConfigs.LogMetricsKey">
<summary>
Key for the LogMetrics property.
<seealso cref="P:Amazon.AWSConfigs.LogMetrics"/>
</summary>
</member>
<member name="P:Amazon.AWSConfigs.LogMetrics">
<summary>
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:
<code>
<appSettings>
<add key="AWSLogMetrics" value="true"/>
</appSettings>
</code>
</summary>
</member>
<member name="F:Amazon.AWSConfigs.EndpointDefinitionKey">
<summary>
Key for the EndpointDefinition property.
<seealso cref="P:Amazon.AWSConfigs.LogMetrics"/>
</summary>
</member>
<member name="P:Amazon.AWSConfigs.EndpointDefinition">
<summary>
Configures if the SDK should use a custom configuration file that defines the regions and endpoints.
<code>
<configSections>
<section name="aws" type="Amazon.AWSSection, AWSSDK"/>
</configSections>
<aws endpointDefinition="c:\config\endpoints.xml" />
</code>
</summary>
</member>
<member name="F:Amazon.AWSConfigs.UseSdkCacheKey">
<summary>
Key for the UseSdkCache property.
<seealso cref="P:Amazon.AWSConfigs.UseSdkCache"/>
</summary>
</member>
<member name="P:Amazon.AWSConfigs.UseSdkCache">
<summary>
Configures if the SDK Cache should be used, the default value is true.
<code>
<configSections>
<section name="aws" type="Amazon.AWSSection, AWSSDK"/>
</configSections>
<aws useSdkCache="true" />
</code>
</summary>
</member>
<member name="P:Amazon.AWSConfigs.LoggingConfig">
<summary>
Configuration for the Logging section of AWS configuration.
Changes to some settings may not take effect until a new client is constructed.
Example section:
<code>
<configSections>
<section name="aws" type="Amazon.AWSSection, AWSSDK"/>
</configSections>
<aws>
<logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" />
</aws>
</code>
</summary>
</member>
<member name="P:Amazon.AWSConfigs.ProxyConfig">
<summary>
Configuration for the Proxy section of AWS configuration.
Changes to some settings may not take effect until a new client is constructed.
Example section:
<code>
<configSections>
<section name="aws" type="Amazon.AWSSection, AWSSDK"/>
</configSections>
<aws>
<proxy host="localhost" port="8888" username="1" password="1" />
</aws>
</code>
</summary>
</member>
<member name="P:Amazon.AWSConfigs.RegionEndpoint">
<summary>
Configuration for the region endpoint section of AWS configuration.
Changes may not take effect until a new client is constructed.
Example section:
<code>
<configSections>
<section name="aws" type="Amazon.AWSSection, AWSSDK"/>
</configSections>
<aws region="us-west-2" />
</code>
</summary>
</member>
<member name="P:Amazon.AWSConfigs.ApplicationName">
<summary>
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.
<code>
<configSections>
<section name="aws" type="Amazon.AWSSection, AWSSDK"/>
</configSections>
<aws applicationName="" />
</code>
</summary>
</member>
<member name="M:Amazon.AWSConfigs.AddTraceListener(System.String,System.Diagnostics.TraceListener)">
<summary>
Add a listener for SDK logging.
</summary>
<remarks>If the listener does not have a name, you will not be able to remove it later.</remarks>
<param name="source">The source to log for, e.g. "Amazon", or "Amazon.DynamoDB".</param>
<param name="listener">The listener to add.</param>
</member>
<member name="M:Amazon.AWSConfigs.RemoveTraceListener(System.String,System.String)">
<summary>
Remove a trace listener from SDK logging.
</summary>
<param name="source">The source the listener was added to.</param>
<param name="name">The name of the listener.</param>
</member>
<member name="M:Amazon.AWSConfigs.GenerateConfigTemplate">
<summary>
Generates a sample XML representation of the SDK condiguration section.
</summary>
<remarks>
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.
</remarks>
<returns>Sample XML configuration string.</returns>
</member>
<member name="T:Amazon.LoggingOptions">
<summary>
Logging options.
Can be combined to enable multiple loggers.
</summary>
</member>
<member name="F:Amazon.LoggingOptions.None">
<summary>
No logging
</summary>
</member>
<member name="F:Amazon.LoggingOptions.Log4Net">
<summary>
Log using log4net
</summary>
</member>
<member name="F:Amazon.LoggingOptions.SystemDiagnostics">
<summary>
Log using System.Diagnostics
</summary>
</member>
<member name="T:Amazon.ResponseLoggingOption">
<summary>
Response logging option.
</summary>
</member>
<member name="F:Amazon.ResponseLoggingOption.Never">
<summary>
Never log service response
</summary>
</member>
<member name="F:Amazon.ResponseLoggingOption.OnError">
<summary>
Only log service response when there's an error
</summary>
</member>
<member name="F:Amazon.ResponseLoggingOption.Always">
<summary>
Always log service response
</summary>
</member>
<member name="T:Amazon.LogMetricsFormatOption">
<summary>
Format for metrics data in the logs
</summary>
</member>
<member name="F:Amazon.LogMetricsFormatOption.Standard">
<summary>
Emit metrics in human-readable format
</summary>
</member>
<member name="F:Amazon.LogMetricsFormatOption.JSON">
<summary>
Emit metrics as JSON data
</summary>
</member>
<member name="T:Amazon.RegionEndpoint">
<summary>
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.
</summary>
</member>
<member name="F:Amazon.RegionEndpoint.USEast1">
<summary>
The US East (Virginia) endpoint.
</summary>
</member>
<member name="F:Amazon.RegionEndpoint.USWest1">
<summary>
The US West (N. California) endpoint.
</summary>
</member>
<member name="F:Amazon.RegionEndpoint.USWest2">
<summary>
The US West (Oregon) endpoint.
</summary>
</member>
<member name="F:Amazon.RegionEndpoint.EUWest1">
<summary>
The EU West (Ireland) endpoint.
</summary>
</member>
<member name="F:Amazon.RegionEndpoint.EUCentral1">
<summary>
The EU Central (Frankfurt) endpoint.
</summary>
</member>
<member name="F:Amazon.RegionEndpoint.APNortheast1">
<summary>
The Asia Pacific (Tokyo) endpoint.
</summary>
</member>
<member name="F:Amazon.RegionEndpoint.APSoutheast1">
<summary>
The Asia Pacific (Singapore) endpoint.
</summary>
</member>
<member name="F:Amazon.RegionEndpoint.APSoutheast2">
<summary>
The Asia Pacific (Sydney) endpoint.
</summary>
</member>
<member name="F:Amazon.RegionEndpoint.SAEast1">
<summary>
The South America (Sao Paulo) endpoint.
</summary>
</member>
<member name="F:Amazon.RegionEndpoint.USGovCloudWest1">
<summary>
The US GovCloud West (Oregon) endpoint.
</summary>
</member>
<member name="F:Amazon.RegionEndpoint.CNNorth1">
<summary>
The China (Beijing) endpoint.
</summary>
</member>
<member name="M:Amazon.RegionEndpoint.GetEndpointForService(System.String)">
<summary>
Gets the endpoint for a service in a region.
</summary>
<param name="serviceName">The services system name.</param>
<exception cref="T:System.ArgumentException">Thrown when the request service does not have a valid endpoint in the region.</exception>
<returns></returns>
</member>
<member name="P:Amazon.RegionEndpoint.EnumerableAllRegions">
<summary>
Enumerate through all the regions.
</summary>
</member>
<member name="M:Amazon.RegionEndpoint.GetBySystemName(System.String)">
<summary>
Gets the region based on its system name like "us-west-1"
</summary>
<param name="systemName">The system name of the service like "us-west-1"</param>
<returns></returns>
</member>
<member name="M:Amazon.RegionEndpoint.UnloadEndpointDefinitions">
<summary>
This is a testing method and should not be called by production applications.
</summary>
</member>
<member name="P:Amazon.RegionEndpoint.SystemName">
<summary>
Gets the system name of a region.
</summary>
</member>
<member name="P:Amazon.RegionEndpoint.DisplayName">
<summary>
Gets the display name of a region.
</summary>
</member>
<member name="T:Amazon.RegionEndpoint.Endpoint">
<summary>
This class defines an endpoints hostname and which protocols it supports.
</summary>
</member>
<member name="P:Amazon.RegionEndpoint.Endpoint.Hostname">
<summary>
Gets the hostname for the service.
</summary>
</member>
<member name="P:Amazon.RegionEndpoint.Endpoint.AuthRegion">
<summary>
The authentication region to be used in request signing.
</summary>
</member>
<member name="P:Amazon.RegionEndpoint.Endpoint.SignatureVersionOverride">
<summary>
Overrides the default signing protocol for an
endpoint. Typically used to force Signature V4
for services that can support multiple signing
protocols.
</summary>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifier">
<summary>
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.
<para>
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.
</para>
<para>
The action is B in the statement
"A has permission to do B to C where D applies."
</para>
<para>Free form access control policy actions may include a wildcard (*) to match
multiple actions.
</para>
<para>
Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace.
</para>
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ActionIdentifier.#ctor(System.String)">
<summary>
Constructs an Actionidentifer with the given action name.
</summary>
<param name="actionName">The name of the action</param>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.ActionIdentifier.ActionName">
<summary>
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.
</summary>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.Condition">
<summary>
AWS access control policy conditions are contained in <see cref="T:Amazon.Auth.AccessControlPolicy.Statement"/>
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.
<para>
Multiple conditions can be included in a single statement, and all conditions
must evaluate to true in order for the statement to take effect.
</para>
<para>
The set of conditions is D in the statement
"A has permission to do B to C where D applies."
</para>
<para>
A condition is composed of three parts:
<list type="definition">
<item>
<term>Condition Key</term>
<description>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 <see cref="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.SOURCE_IP_CONDITION_KEY"/> 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.
</description>
</item>
<item>
<term>Comparison Type</term>
<description>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.
</description>
</item>
<item>
<term>Comparison Value</term>
<description>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.
</description>
</item>
</list>
</para>
</summary>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.Condition.Type">
<summary>
Gets the type of this condition.
</summary>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.Condition.ConditionKey">
<summary>
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.
<para>
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.
</para>
</summary>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.Condition.Values">
<summary>
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.
<para>
Most conditions accept only one value, but multiple values are possible.
</para>
</summary>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ConditionFactory">
<summary>
A factory for creating conditions to be used in the policy.
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.CURRENT_TIME_CONDITION_KEY">
<summary>
Condition key for the current time.
<para>
This condition key should only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.DateComparisonType"/> enum.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.SECURE_TRANSPORT_CONDITION_KEY">
<summary>
Condition key for whether or not an incoming request is using a secure
transport to make the request (i.e. HTTPS instead of HTTP).
<para>
This condition key should only be used with the boolean overload of NewCondition.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.SOURCE_IP_CONDITION_KEY">
<summary>
Condition key for the source IP from which a request originates.
<para>
This condition key should only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.IpAddressComparisonType"/> enum.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.USER_AGENT_CONDITION_KEY">
<summary>
Condition key for the user agent included in a request.
<para>
This condition key should only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/>
enum.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.EPOCH_TIME_CONDITION_KEY">
<summary>
Condition key for the current time, in epoch seconds.
<para>
This condition key should only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.NumericComparisonType"/> enum.
objects.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.REFERRER_CONDITION_KEY">
<summary>
Condition key for the referrer specified by a request.
<para>
This condition key should only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/>
objects.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.SOURCE_ARN_CONDITION_KEY">
<summary>
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.
<para>
This condition key should only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.ArnComparisonType"/> enum.
</para>
</summary>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.ArnComparisonType">
<summary>
Enumeration of the supported ways an ARN comparison can be evaluated.
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.ArnComparisonType.ArnEquals">
<summary>Exact matching</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.ArnComparisonType.ArnLike">
<summary>
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 (?).
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.ArnComparisonType.ArnNotEquals">
<summary>Negated form of ArnEquals</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.ArnComparisonType.ArnNotLike">
<summary>Negated form of ArnLike</summary>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.DateComparisonType">
<summary>
Enumeration of the supported ways a date comparison can be evaluated.
</summary>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.IpAddressComparisonType">
<summary>
Enumeration of the supported ways an IP address comparison can be evaluated.
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.IpAddressComparisonType.IpAddress">
<summary>
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.
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.IpAddressComparisonType.NotIpAddress">
<summary>
Negated form of IpAddress
</summary>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.NumericComparisonType">
<summary>
Enumeration of the supported ways a numeric comparison can be evaluated
</summary>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType">
<summary>
Enumeration of the supported ways a string comparison can be evaluated.
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType.StringEquals">
<summary>
Case-sensitive exact string matching
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType.StringEqualsIgnoreCase">
<summary>
Case-insensitive string matching
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType.StringLike">
<summary>
Loose case-insensitive matching. The values can include a
multi-character match wildcard (*) or a single-character match
wildcard (?) anywhere in the string.
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType.StringNotEquals">
<summary>
Negated form of StringEquals.
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType.StringNotEqualsIgnoreCase">
<summary>
Negated form of StringEqualsIgnorecase.
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType.StringNotLike">
<summary>
Negated form of StringLike.
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewCondition(Amazon.Auth.AccessControlPolicy.ConditionFactory.ArnComparisonType,System.String,System.String)">
<summary>
Constructs a new access control policy condition that compares ARNs (Amazon Resource Names).
</summary>
<param name="key"> The access policy condition key specifying where to get the first ARN for the comparison</param>
<param name="type">The type of comparison to perform.</param>
<param name="value">The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the
multi-character wildcard (*) or the single-character wildcard</param>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewCondition(System.String,System.Boolean)">
<summary>
Constructs a new access policy condition that performs a boolean
comparison.
</summary>
<param name="key">The access policy condition key specifying where to get the
first boolean value for the comparison (ex: aws:SecureTransport).</param>
<param name="value">The boolean to compare against.</param>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewCondition(Amazon.Auth.AccessControlPolicy.ConditionFactory.DateComparisonType,System.DateTime)">
<summary>
Constructs a new access policy condition that compares the current time
(on the AWS servers) to the specified date.
</summary>
<param name="type">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.</param>
<param name="date">The date to compare against.</param>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewIpAddressCondition(System.String)">
<summary>
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.
<para>
To achieve the opposite effect (i.e. cause the condition to evaluate to
true when the incoming source IP is <b>not</b> in the specified CIDR
range) use the alternate constructor form and specify
IpAddressComparisonType.NotIpAddress.
</para>
</summary>
<param name="ipAddressRange">The CIDR IP range involved in the policy condition.</param>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewCondition(Amazon.Auth.AccessControlPolicy.ConditionFactory.IpAddressComparisonType,System.String)">
<summary>
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.
</summary>
<param name="type">The type of comparison to to perform.</param>
<param name="ipAddressRange">The CIDR IP range involved in the policy condition.</param>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewCondition(Amazon.Auth.AccessControlPolicy.ConditionFactory.NumericComparisonType,System.String,System.String)">
<summary>
Constructs a new access policy condition that compares two numbers.
</summary>
<param name="type">The type of comparison to perform.</param>
<param name="key">The access policy condition key specifying where to get the
first number for the comparison.</param>
<param name="value">The second number to compare against.</param>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewCondition(Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType,System.String,System.String)">
<summary>
Constructs a new access control policy condition that compares two
strings.
</summary>
<param name="type">The type of comparison to perform</param>
<param name="key">The access policy condition key specifying where to get the
first string for the comparison (ex: aws:UserAgent).
</param>
<param name="value">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 (?).
</param>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewSourceArnCondition(System.String)">
<summary>
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.
<para>
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.
</para>
<para>
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.
</para>
<code>
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)));
</code>
</summary>
<param name="arnPattern">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.</param>
<returns>A new access control policy condition that compares the ARN of
the source specified in an incoming request with the ARN pattern
specified here.</returns>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewSecureTransportCondition">
<summary>
Constructs a new access control policy condition that tests if the
incoming request was sent over a secure transport (HTTPS).
</summary>
<returns>A new access control policy condition that tests if the incoming
request was sent over a secure transport (HTTPS).</returns>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_CANNED_ACL_CONDITION_KEY">
<summary>
Condition key for the canned ACL specified by a request.
<para>
This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_LOCATION_CONSTRAINT_CONDITION_KEY">
<summary>
Condition key for the location constraint specified by a request.
<para>
This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_PREFIX_CONDITION_KEY">
<summary>
Condition key for the prefix specified by a request.
<para>
This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_DELIMITER_CONDITION_KEY">
<summary>
Condition key for the delimiter specified by a request.
<para>
This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_MAX_KEYS_CONDITION_KEY">
<summary>
Condition key for the max keys specified by a request.
<para>
This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_COPY_SOURCE_CONDITION_KEY">
<summary>
Condition key for the source object specified by a request to copy an
object.
<para>
This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_METADATA_DIRECTIVE_CONDITION_KEY">
<summary>
Condition key for the metadata directive specified by a request to copy
an object.
<para>
This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_VERSION_ID_CONDITION_KEY">
<summary>
Condition key for the version ID of an object version specified by a
request.
<para>
This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum.
</para>
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewCannedACLCondition(System.String)">
<summary>
Constructs a new access policy condition that compares an Amazon S3
canned ACL with the canned ACL specified by an incoming request.
<para>
You can use this condition to ensure that any objects uploaded to an
Amazon S3 bucket have a specific canned ACL set.
</para>
</summary>
<param name="cannedAcl">The Amazon S3 canned ACL to compare against.</param>
<returns>A new access control policy condition that compares the Amazon S3
canned ACL specified in incoming requests against the value
specified.</returns>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.SNS_ENDPOINT_CONDITION_KEY">
<summary>
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).
<para>
This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.SNS_PROTOCOL_CONDITION_KEY">
<summary>
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).
<para>
This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum.
</para>
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewEndpointCondition(System.String)">
<summary>
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 (?).
<para>
For example, this condition can restrict subscriptions to a topic to
email addresses in a certain domain ("*@my-company.com").
</para>
<code>
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")));
</code>
</summary>
<param name="endpointPattern">The endpoint pattern against which to compare the requested
endpoint for an Amazon SNS topic subscription.</param>
<returns>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.</returns>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewProtocolCondition(System.String)">
<summary>
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.
</summary>
<param name="protocol">The protocol against which to compare the requested protocol
for an Amazon SNS topic subscription.</param>
<returns>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.</returns>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.Policy">
<summary>
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.
<para>
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.
</para>
<para>
Each statement in an AWS access control policy takes the form:
"A has permission to do B to C where D applies".
<list type="definition">
<item>
<term>A is the prinicpal</term>
<description>The AWS account that is making a request to
access or modify one of your AWS resources.
</description>
</item>
<item>
<term>B is the action</term>
<description>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.
</description>
</item>
<item>
<term>C is the resource</term>
<description>your AWS entity that the principal wants to access, such
as an Amazon SQS queue, or an object stored in Amazon S3.
</description>
</item>
<item>
<term>D is the set of conditions</term>
<description>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.
</description>
</item>
</list>
</para>
<para>
Note that an AWS access control policy should not be confused with the
similarly named "POST form policy" concept used in Amazon S3.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.Policy.DEFAULT_POLICY_VERSION">
<summary>
The default policy version
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Policy.#ctor">
<summary>
Constructs an empty AWS access control policy ready to be populated with
statements.
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Policy.#ctor(System.String)">
<summary>
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.
</summary>
<param name="id">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.</param>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Policy.#ctor(System.String,System.Collections.Generic.IList{Amazon.Auth.AccessControlPolicy.Statement})">
<summary>
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.
</summary>
<param name="id">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.</param>
<param name="statements">The statements to include in the new policy.</param>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.Policy.Id">
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Policy.WithId(System.String)">
<summary>
Sets the policy ID for this policy and returns the updated policy so that
multiple calls can be chained together.
<para>
Policy IDs serve to help developers keep track of multiple policies, and
are often used as human readable name for a policy.
</para>
</summary>
<paraparam name="id">The polich ID for this policy</paraparam>
<returns>this instance</returns>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.Policy.Version">
<summary>
Gets and sets the version of this AWS policy.
</summary>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.Policy.Statements">
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Policy.CheckIfStatementExists(Amazon.Auth.AccessControlPolicy.Statement)">
<summary>
Checks to see if the permissions set in the statement are already set by another
statement in the policy.
</summary>
<param name="statement">The statement to verify</param>
<returns>True if the statement's permissions are already allowed by the statement</returns>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Policy.WithStatements(Amazon.Auth.AccessControlPolicy.Statement[])">
<summary>
Sets the collection of statements contained by this policy and returns
this policy object so that additional method calls can be chained
together.
<para>
Individual statements in a policy are what specify the rules that enable
or disable access to your AWS resources.
</para>
</summary>
<param name="statements">The collection of statements included in this policy.</param>
<returns>this instance</returns>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Policy.ToJson">
<summary>
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.
</summary>
<returns>A JSON string representation of this AWS access control policy.</returns>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Policy.ToJson(System.Boolean)">
<summary>
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.
</summary>
<param name="prettyPrint">Toggle pretty print for the generated JSON document</param>
<returns>A JSON string representation of this AWS access control policy.</returns>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Policy.FromJson(System.String)">
<summary>
Parses a JSON document of a policy and creates a Policy object.
</summary>
<param name="json">JSON document of a policy.</param>
<returns></returns>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.Principal">
<summary>
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 <see cref="T:Amazon.Auth.AccessControlPolicy.Policy"/> object.
<para>
The principal is A in the statement
"A has permission to do B to C where D applies."
</para>
<para>
In an access control policy statement, you can set the principal to all
authenticated AWS users through the <see cref="F:Amazon.Auth.AccessControlPolicy.Principal.AllUsers"/> 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.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.Principal.AllUsers">
<summary>
Principal instance that includes all authenticated AWS users.
<para>
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.
</para>
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.Principal.Anonymous">
<summary>
The anonymous Principal.
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.Principal.AWS_PROVIDER">
<summary>
The default Principal provider for AWS accounts.
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.Principal.CANONICAL_USER_PROVIDER">
<summary>
Principal provider for Canonical User IDs.
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.Principal.FEDERATED_PROVIDER">
<summary>
Principal provider for federated users (using a SAML identity provider)
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.Principal.SERVICE_PROVIDER">
<summary>
Principal provider for assume role policies that will be assumed by an AWS service
(e.g. "ec2.amazonaws.com").
</summary>
</member>
<member name="F:Amazon.Auth.AccessControlPolicy.Principal.ANONYMOUS_PROVIDER">
<summary>
Dummy principal provider for anonynous.
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Principal.#ctor(System.String)">
<summary>
Constructs a new principal with the specified AWS account ID.
</summary>
<param name="accountId">An AWS account ID.</param>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Principal.#ctor(System.String,System.String)">
<summary>
Constructs a new principal with the specified provider and id
</summary>
<param name="provider">The provider of the principal</param>
<param name="id">The unique ID of the Principal within the provider</param>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.Principal.Provider">
<summary>
Gets and sets the provider for this principal, which indicates in what group of
users this principal resides.
</summary>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.Principal.Id">
<summary>
Gets the unique ID for this principal.
</summary>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.Resource">
<summary>
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.
<para>
The standard way of specifying an AWS resource is with an Amazon Resource
Name (ARN).
</para>
<para>
The resource is C in the statement
"A has permission to do B to C where D applies."
</para>
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Resource.#ctor(System.String)">
<summary>
Constructs a new AWS access control policy resource. Resources are
typically specified as Amazon Resource Names (ARNs).
<para>
You specify the resource using the following Amazon Resource Name (ARN)
format: arn:aws:<vendor>:<region>:<namespace>:<relative-id>
<list type="bullet">
<item>
<description>>vendor identifies the AWS product (e.g., sns)</description>
</item>
<item>
<description>region is the AWS Region the resource resides in (e.g., us-east-1), if any</description>
</item>
<item>
<description>namespace is the AWS account ID with no hyphens (e.g., 123456789012)</description>
</item>
<item>
<description>relative-id is the service specific portion that identifies the specific resource</description>
</item>
</list>
</para>
<para>
For example, an Amazon SQS queue might be addressed with the following
ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue
</para>
<para>
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/*
</para>
</summary>
<param name="resource">The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource.</param>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.Resource.Id">
<summary>
Gets the resource ID, typically an Amazon Resource Name (ARN),
identifying this resource.
</summary>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ResourceFactory">
<summary>
A factory for creating resources to be used in the policy.
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ResourceFactory.NewS3BucketResource(System.String)">
<summary>
Constructs a new bucket resource that represents the the specified bucket
but <b>not any of the contained objects</b>.
</summary>
<param name="bucketName">The name of the bucket represented by this AWS access control
policy resource.</param>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ResourceFactory.NewS3ObjectResource(System.String,System.String)">
<summary>
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'.
</summary>
<param name="bucketName">The name of the bucket containing the object or objects
represented by this resource.</param>
<param name="keyPattern">The key or key pattern, which can optionally contain the '*'
wildcard to include multiple objects in the resource.</param>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.ResourceFactory.NewSQSQueueResource(System.String,System.String)">
<summary>
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.
</summary>
<param name="accountId">The AWS account ID of the queue owner.</param>
<param name="queueName">The name of the Amazon SQS queue.</param>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.Statement">
<summary>
A statement is the formal description of a single permission, and is always
contained within a policy object.
<para>
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.
</para>
<para>
For example, consider a statement that:
<list type="definition">
<item>
<term>A is the prinicpal</term>
<description>The AWS account that is making a request to
access or modify one of your AWS resources.
</description>
</item>
<item>
<term>B is the action</term>
<description>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.
</description>
</item>
<item>
<term>C is the resource</term>
<description>your AWS entity that the principal wants to access, such
as an Amazon SQS queue, or an object stored in Amazon S3.
</description>
</item>
<item>
<term>D is the set of conditions</term>
<description>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.
</description>
</item>
</list>
</para>
<para>
There are many resources and conditions available for use in statements, and
you can combine them to form fine grained custom access control polices.
</para>
</summary>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.Statement.StatementEffect">
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Statement.#ctor(Amazon.Auth.AccessControlPolicy.Statement.StatementEffect)">
<summary>
Constructs a new access control policy statement with the specified
effect.
<para>
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.
</para>
</summary>
<param name="effect">The effect this statement has (allowing access or denying
access) when all conditions, resources, principals, and
actions are matched.</param>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.Statement.Id">
<summary>
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.
<para>
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.
</para>
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Statement.WithId(System.String)">
<summary>
Sets the ID for this statement and returns the updated statement so
multiple calls can be chained together.
<para>
Statement IDs serve to help keep track of multiple statements, and are
often used to give the statement a meaningful, human readable name.
</para>
<para>
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.
</para>
</summary>
<param name="id">The new statement ID for this statement.</param>
<returns>this instance</returns>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.Statement.Effect">
<summary>
Gets and Sets the result effect of this policy statement when it is evaluated.
A policy statement can either allow access or explicitly
</summary>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.Statement.Actions">
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Statement.WithActionIdentifiers(Amazon.Auth.AccessControlPolicy.ActionIdentifier[])">
<summary>
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.
<para>
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.
</para>
</summary>
<param name="actions">The list of actions to which this statement applies.</param>
<returns>this instance</returns>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.Statement.Resources">
<summary>
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.
<para>
Note that some services allow only one resource to be specified per
policy statement.
</para>
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Statement.WithResources(Amazon.Auth.AccessControlPolicy.Resource[])">
<summary>
Sets the resources associated with this policy statement and returns this
updated Statement object so that additional method calls can be chained
together.
<para>
Resources are what a policy statement is allowing or denying access to,
such as an Amazon SQS queue or an Amazon SNS topic.
</para>
<para>
Note that some services allow only one resource to be specified per
policy statement.
</para>
</summary>
<param name="resources">The resources associated with this policy statement.</param>
<returns>this instance</returns>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.Statement.Conditions">
<summary>
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.
<para>
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.
</para>
<para>
When multiple conditions are included in a single statement, all
conditions must evaluate to true in order for the statement to take
effect.
</para>
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Statement.WithConditions(Amazon.Auth.AccessControlPolicy.Condition[])">
<summary>
Sets the conditions associated with this policy statement, and returns
this updated Statement object so that additional method calls can be
chained together.
<para>
Conditions allow policy statements to be conditionally evaluated based on
the many available condition types.
</para>
<para>
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.
</para>
<para>
Multiple conditions can be included in a single statement, and all
conditions must evaluate to true in order for the statement to take
effect.
</para>
</summary>
<param name="conditions">The conditions associated with this policy statement.</param>
<returns>this instance</returns>
</member>
<member name="P:Amazon.Auth.AccessControlPolicy.Statement.Principals">
<summary>
Gets and Sets the principals associated with this policy statement, indicating
which AWS accounts are affected by this policy statement.
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Statement.WithPrincipals(Amazon.Auth.AccessControlPolicy.Principal[])">
<summary>
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.
<para>
If you don't want to restrict your policy to specific users, you can use
<see cref="F:Amazon.Auth.AccessControlPolicy.Principal.AllUsers"/> to apply the policy to any user trying to
access your resource.
</para>
</summary>
<param name="principals">The list of principals associated with this policy statement.</param>
<returns>this instance</returns>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.AppStreamActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon AppStream.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.AutoScalingActionIdentifiers">
<summary>
The available AWS access control policy actions for Auto Scaling.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.BillingActionIdentifiers">
<summary>
The available AWS access control policy actions for AWS Billing.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.CloudFormationActionIdentifiers">
<summary>
The available AWS access control policy actions for AWS CloudFormation.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.CloudFrontActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon CloudFront.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.CloudSearchActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon CloudSearch.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.CloudTrailActionIdentifiers">
<summary>
The available AWS access control policy actions for AWS CloudTrail.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.CloudWatchActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon CloudWatch.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.CloudWatchLogsActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon CloudWatch Logs.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.CognitoIdentityActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon Cognito Identity.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.CognitoSyncActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon Cognito Sync.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.DirectConnectActionIdentifiers">
<summary>
The available AWS access control policy actions for AWS Direct Connect.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.DynamoDBActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon DynamoDB.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.EC2ActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon EC2.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.ElastiCacheActionIdentifiers">
<summary>
The available AWS access control policy actions for AWS ElastiCache.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.ElasticBeanstalkActionIdentifiers">
<summary>
The available AWS access control policy actions for AWS Elastic Beanstalk.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.ElasticLoadBalancingActionIdentifiers">
<summary>
The available AWS access control policy actions for Elastic Load Balancing.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.ElasticMapReduceActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon Elastic MapReduce.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.ElasticTranscoderActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon Elastic Transcoder.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.GlacierActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon Glacier.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.IdentityandAccessManagementActionIdentifiers">
<summary>
The available AWS access control policy actions for AWS Identity and Access Management.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.ImportExportActionIdentifiers">
<summary>
The available AWS access control policy actions for AWS Import Export.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.KinesisActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon Kinesis.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.MarketplaceActionIdentifiers">
<summary>
The available AWS access control policy actions for AWS Marketplace.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.MarketplaceManagementPortalActionIdentifiers">
<summary>
The available AWS access control policy actions for AWS Marketplace Management Portal.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.MobileAnalyticsActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon Mobile Analytics.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.OpsWorksActionIdentifiers">
<summary>
The available AWS access control policy actions for AWS OpsWorks.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.RDSActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon RDS.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.RedshiftActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon Redshift.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.Route53ActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon Route 53.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.S3ActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon S3.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.SecurityTokenServiceActionIdentifiers">
<summary>
The available AWS access control policy actions for AWS Security Token Service.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.SESActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon SES.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.SimpleDBActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon SimpleDB.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.SimpleWorkflowServiceActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon Simple Workflow Service.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.SNSActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon SNS.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.SQSActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon SQS.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.StorageGatewayActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon Storage Gateway.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.WhispersyncActionIdentifiers">
<summary>
The available AWS access control policy actions for AWS Whispersync.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.ZocaloActionIdentifiers">
<summary>
The available AWS access control policy actions for Amazon Zocalo.
</summary>
<see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.Internal.JsonPolicyReader">
<summary>
Deserializes a JSON string into a AWS policy object.
</summary>
</member>
<member name="T:Amazon.Auth.AccessControlPolicy.Internal.JsonPolicyWriter">
<summary>
Serializes an AWS policy object to a JSON string, suitable for sending to an
AWS service.
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Internal.JsonPolicyWriter.WritePolicyToString(System.Boolean,Amazon.Auth.AccessControlPolicy.Policy)">
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.
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Internal.JsonPolicyWriter.writePrincipals(Amazon.Auth.AccessControlPolicy.Statement,ThirdParty.Json.LitJson.JsonWriter)">
<summary>
Uses the specified generator to write the JSON data for the principals in
the specified policy statement.
</summary>
</member>
<member name="M:Amazon.Auth.AccessControlPolicy.Internal.JsonPolicyWriter.sortConditionsByTypeAndKey(System.Collections.Generic.IList{Amazon.Auth.AccessControlPolicy.Condition})">
<summary>
This sorts the conditions by condition type and key with the list of values for that combination.
</summary>
<param name="conditions">The list of conditions to be sorted.</param>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.AmazonClientException">
<summary>
Exception thrown by the SDK for errors that occur within the SDK.
</summary>
</member>
<member name="T:Amazon.Runtime.AmazonDateTimeUnmarshallingException">
<summary>
This exception is thrown when there is a parse error on the response back from AWS.
</summary>
</member>
<member name="P:Amazon.Runtime.AmazonDateTimeUnmarshallingException.InvalidDateTimeToken">
<summary>
The string value which could not be converted into a valid DateTime instance.
</summary>
</member>
<member name="E:Amazon.Runtime.AmazonServiceClient.BeforeMarshallingEvent">
<summary>
Occurs before a request is marshalled.
</summary>
</member>
<member name="E:Amazon.Runtime.AmazonServiceClient.BeforeRequestEvent">
<summary>
Occurs before a request is issued against the service.
</summary>
</member>
<member name="E:Amazon.Runtime.AmazonServiceClient.AfterResponseEvent">
<summary>
Occurs after a response is received from the service.
</summary>
</member>
<member name="E:Amazon.Runtime.AmazonServiceClient.ExceptionEvent">
<summary>
Occurs after an exception is encountered.
</summary>
</member>
<member name="M:Amazon.Runtime.AmazonServiceClient.DontUnescapePathDotsAndSlashes(System.Uri)">
<summary>
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.
</summary>
<remarks>
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.
</remarks>
<param name="uri"></param>
</member>
<member name="M:Amazon.Runtime.AmazonServiceClient.CloneConfig``1">
<summary>
Used to create a copy of the config for a different service than the current instance.
</summary>
<typeparam name="C">Target service ClientConfig</typeparam>
<returns>The new ClientConfig for the desired service</returns>
</member>
<member name="T:Amazon.Runtime.AmazonServiceException">
<summary>
A base exception for some Amazon Web Services.
<para>
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.
</para>
</summary>
</member>
<member name="P:Amazon.Runtime.AmazonServiceException.ErrorType">
<summary>
Whether the error was attributable to <c>Sender</c> or <c>Reciever</c>.
</summary>
</member>
<member name="P:Amazon.Runtime.AmazonServiceException.ErrorCode">
<summary>
The error code returned by the service
</summary>
</member>
<member name="P:Amazon.Runtime.AmazonServiceException.RequestId">
<summary>
The id of the request which generated the exception.
</summary>
</member>
<member name="P:Amazon.Runtime.AmazonServiceException.StatusCode">
<summary>
The HTTP status code from the service response
</summary>
</member>
<member name="T:Amazon.Runtime.AmazonUnmarshallingException">
<summary>
This exception is thrown when there is a parse error on the response back from AWS.
</summary>
</member>
<member name="P:Amazon.Runtime.AmazonUnmarshallingException.LastKnownLocation">
<summary>
Last known location in the response that was parsed, if available.
</summary>
</member>
<member name="P:Amazon.Runtime.AmazonUnmarshallingException.ResponseBody">
<summary>
The entire response body that caused this exception, if available.
</summary>
</member>
<member name="T:Amazon.Runtime.AmazonWebServiceRequest">
<summary>
Base class for request used by some of the services.
</summary>
</member>
<member name="P:Amazon.Runtime.AmazonWebServiceRequest.Amazon#Runtime#Internal#IAmazonWebServiceRequest#UseSigV4">
<summary>
This flag specifies if SigV4 will be used for the current request.
</summary>
</member>
<member name="P:Amazon.Runtime.AmazonWebServiceRequest.Expect100Continue">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.AmazonWebServiceRequest.TimeoutInternal">
<summary>
Overrides the default request timeout value.
</summary>
<remarks>
<para>
If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used
to send requests.
</para>
<para>
Please specify a timeout value only if the operation will not complete within the default intervals
specified for an HttpWebRequest/HttpClient.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException">The timeout specified is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The timeout specified is less than or equal to zero and is not Infinite.</exception>
<seealso cref="P:System.Net.HttpWebRequest.Timeout"/>
<seealso cref="P:System.Net.Http.HttpClient.Timeout"/>
</member>
<member name="P:Amazon.Runtime.AmazonWebServiceRequest.ReadWriteTimeoutInternal">
<summary>
Overrides the default read-write timeout value.
</summary>
<remarks>
<para>
If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used
to send requests.
</para>
<exception cref="T:System.ArgumentNullException">The timeout specified is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The timeout specified is less than or equal to zero and is not Infinite.</exception>
</remarks>
<seealso cref="P:System.Net.HttpWebRequest.ReadWriteTimeout"/>
<seealso cref="P:System.Net.Http.WebRequestHandler.ReadWriteTimeout"/>
</member>
<member name="T:Amazon.Runtime.AmazonWebServiceResponse">
<summary>
Abstract class for Response objects, contains only metadata,
and no result information.
</summary>
</member>
<member name="P:Amazon.Runtime.AmazonWebServiceResponse.ResponseMetadata">
<summary>
Contains additional information about the request, such as the
Request Id.
</summary>
</member>
<member name="P:Amazon.Runtime.AmazonWebServiceResponse.ContentLength">
<summary>
Returns the content length of the HTTP response.
</summary>
</member>
<member name="P:Amazon.Runtime.AmazonWebServiceResponse.HttpStatusCode">
<summary>
Returns the status code of the HTTP response.
</summary>
</member>
<member name="T:Amazon.Runtime.ImmutableCredentials">
<summary>
Immutable representation of AWS credentials.
</summary>
</member>
<member name="P:Amazon.Runtime.ImmutableCredentials.AccessKey">
<summary>
Gets the AccessKey property for the current credentials.
</summary>
</member>
<member name="P:Amazon.Runtime.ImmutableCredentials.SecretKey">
<summary>
Gets the SecretKey property for the current credentials.
</summary>
</member>
<member name="P:Amazon.Runtime.ImmutableCredentials.Token">
<summary>
Gets the Token property for the current credentials.
</summary>
</member>
<member name="P:Amazon.Runtime.ImmutableCredentials.UseToken">
<summary>
Gets the UseToken property for the current credentials.
Specifies if Token property is non-emtpy.
</summary>
</member>
<member name="M:Amazon.Runtime.ImmutableCredentials.#ctor(System.String,System.String,System.String)">
<summary>
Constructs an ImmutableCredentials object with supplied accessKey, secretKey.
</summary>
<param name="awsAccessKeyId"></param>
<param name="awsSecretAccessKey"></param>
<param name="token">Optional. Can be set to null or empty for non-session credentials.</param>
</member>
<member name="M:Amazon.Runtime.ImmutableCredentials.Copy">
<summary>
Returns a copy of the current credentials.
</summary>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.AWSCredentials">
<summary>
Abstract class that represents a credentials object for AWS services.
</summary>
</member>
<member name="M:Amazon.Runtime.AWSCredentials.GetCredentials">
<summary>
Returns a copy of ImmutableCredentials
</summary>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.AWSCredentials.Validate">
<summary>
Called by AmazonServiceClient to validate the credential state
on client construction.
</summary>
</member>
<member name="T:Amazon.Runtime.BasicAWSCredentials">
<summary>
Basic set of credentials consisting of an AccessKey and SecretKey
</summary>
</member>
<member name="M:Amazon.Runtime.BasicAWSCredentials.#ctor(System.String,System.String)">
<summary>
Constructs a BasicAWSCredentials object for the specified accessKey and secretKey.
</summary>
<param name="accessKey"></param>
<param name="secretKey"></param>
</member>
<member name="M:Amazon.Runtime.BasicAWSCredentials.GetCredentials">
<summary>
Returns an instance of ImmutableCredentials for this instance
</summary>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.SessionAWSCredentials">
<summary>
Session credentials consisting of AccessKey, SecretKey and Token
</summary>
</member>
<member name="M:Amazon.Runtime.SessionAWSCredentials.#ctor(System.String,System.String,System.String)">
<summary>
Constructs a SessionAWSCredentials object for the specified accessKey, secretKey.
</summary>
<param name="awsAccessKeyId"></param>
<param name="awsSecretAccessKey"></param>
<param name="token"></param>
</member>
<member name="M:Amazon.Runtime.SessionAWSCredentials.GetCredentials">
<summary>
Returns an instance of ImmutableCredentials for this instance
</summary>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.StoredProfileAWSCredentials">
<summary>
Credentials that are retrieved using the stored profile. The SDK Store is searched which is the credentials store shared with the SDK, PowerShell CLI and Toolkit.
To manage the SDK Store with the SDK use Amazon.Util.ProfileManager. If the profile is not found in the SDK Store then credentials file shared with other AWS SDKs
is searched. The credentials file is stored in the .aws directory in the current user's home directory.
<para>
The profile name can be specified in the App.config using the AWSProfileName setting.
</para>
<para>
The location to search for credentials can be overridden in the App.config using the AWSProfilesLocation setting.
</para>
</summary>
</member>
<member name="M:Amazon.Runtime.StoredProfileAWSCredentials.#ctor">
<summary>
Constructs an instance of StoredProfileAWSCredentials. This constructor searches for credentials using the
account name specified in the App.config. If no account is specified then the default credentials are used.
</summary>
</member>
<member name="M:Amazon.Runtime.StoredProfileAWSCredentials.#ctor(System.String)">
<summary>
Constructs an instance of StoredProfileAWSCredentials. Credentials will be searched for using the profileName parameter.
</summary>
<param name="profileName">The profile name to search for credentials for</param>
</member>
<member name="M:Amazon.Runtime.StoredProfileAWSCredentials.#ctor(System.String,System.String)">
<summary>
Constructs an instance of StoredProfileAWSCredentials. Credentials will be searched for using the profileName parameter.
</summary>
<param name="profileName">The profile name to search for credentials for</param>
<param name="profilesLocation">Overrides the location to search for credentials</param>
<remarks>
If credential materials cannot be read or are invalid due to missing data
an InvalidDataException is thrown. If no credentials can be located, an ArgumentException
is thrown.
</remarks>
</member>
<member name="P:Amazon.Runtime.StoredProfileAWSCredentials.ProfileName">
<summary>
Name of the profile being used.
</summary>
</member>
<member name="P:Amazon.Runtime.StoredProfileAWSCredentials.ProfilesLocation">
<summary>
Location of the profiles, if used.
</summary>
</member>
<member name="M:Amazon.Runtime.StoredProfileAWSCredentials.DetermineCredentialsFilePath(System.String)">
<summary>
Determine the location of the shared credentials file.
</summary>
<param name="profilesLocation">If accountsLocation is null then the shared credentials file stored .aws directory under the home directory.</param>
<returns>The file path to the credentials file to be used.</returns>
</member>
<member name="M:Amazon.Runtime.StoredProfileAWSCredentials.GetCredentials">
<summary>
Returns an instance of ImmutableCredentials for this instance
</summary>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.EnvironmentVariablesAWSCredentials">
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Runtime.EnvironmentVariablesAWSCredentials.#ctor">
<summary>
Constructs an instance of EnvironmentVariablesAWSCredentials. If no credentials are found in the environment variables
then an InvalidOperationException.
</summary>
</member>
<member name="M:Amazon.Runtime.EnvironmentVariablesAWSCredentials.GetCredentials">
<summary>
Returns an instance of ImmutableCredentials for this instance
</summary>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.EnvironmentAWSCredentials">
<summary>
Credentials that are retrieved from ConfigurationManager.AppSettings
</summary>
</member>
<member name="M:Amazon.Runtime.EnvironmentAWSCredentials.#ctor">
<summary>
Constructs an instance of EnvironmentAWSCredentials and attempts
to load AccessKey and SecretKey from ConfigurationManager.AppSettings
</summary>
</member>
<member name="M:Amazon.Runtime.EnvironmentAWSCredentials.GetCredentials">
<summary>
Returns an instance of ImmutableCredentials for this instance
</summary>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.RefreshingAWSCredentials">
<summary>
Abstract class for automatically refreshing AWS credentials
</summary>
</member>
<member name="T:Amazon.Runtime.RefreshingAWSCredentials.CredentialsRefreshState">
<summary>
Refresh state container consisting of credentials
and the date of the their expiration
</summary>
</member>
<member name="P:Amazon.Runtime.RefreshingAWSCredentials.PreemptExpiryTime">
<summary>
The time before actual expiration to expire the credentials.
Property cannot be set to a negative TimeSpan.
</summary>
</member>
<member name="M:Amazon.Runtime.RefreshingAWSCredentials.GetCredentials">
<summary>
Returns an instance of ImmutableCredentials for this instance
</summary>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.RefreshingAWSCredentials.GenerateNewCredentials">
<summary>
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.
</summary>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.RefreshingAWSCredentials.GenerateNewCredentialsAsync">
<summary>
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.
</summary>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.RefreshingAWSCredentials.ClearCredentials">
<summary>
Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials.
</summary>
</member>
<member name="T:Amazon.Runtime.InstanceProfileAWSCredentials">
<summary>
Credentials that are retrieved from the Instance Profile service on an EC2 instance
</summary>
</member>
<member name="P:Amazon.Runtime.InstanceProfileAWSCredentials.Role">
<summary>
Role for which the credentials are retrieved
</summary>
</member>
<member name="M:Amazon.Runtime.InstanceProfileAWSCredentials.#ctor(System.String)">
<summary>
Constructs a InstanceProfileAWSCredentials object for specific role
</summary>
<param name="role">Role to use</param>
</member>
<member name="M:Amazon.Runtime.InstanceProfileAWSCredentials.#ctor">
<summary>
Constructs a InstanceProfileAWSCredentials object for the first found role
</summary>
</member>
<member name="M:Amazon.Runtime.InstanceProfileAWSCredentials.GetAvailableRoles">
<summary>
Retrieves a list of all roles available through current InstanceProfile service
</summary>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.AnonymousAWSCredentials">
<summary>
Anonymous credentials.
Using these credentials, the client does not sign the request.
</summary>
</member>
<member name="M:Amazon.Runtime.AnonymousAWSCredentials.GetCredentials">
<summary>
Returns an instance of ImmutableCredentials for this instance
</summary>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.ClientConfig">
<summary>
This class is the base class of all the configurations settings to connect
to a service.
</summary>
<summary>
This class is the base class of all the configurations settings to connect
to a service.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.ServiceVersion">
<summary>
Gets Service Version
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.SignatureMethod">
<summary>
Gets and sets of the signatureMethod property.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.SignatureVersion">
<summary>
Gets and sets of the SignatureVersion property.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.UserAgent">
<summary>
Gets and sets of the UserAgent property.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.RegionEndpoint">
<summary>
Gets and sets 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.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.RegionEndpointServiceName">
<summary>
The constant used to lookup in the region hash the endpoint.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.ServiceURL">
<summary>
Gets and sets of the ServiceURL property.
This is an optional property; change it
only if you want to try a different service
endpoint.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.UseHttp">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.AuthenticationRegion">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.AuthenticationServiceName">
<summary>
Gets and sets the AuthenticationServiceName property.
Used in AWS4 request signing, this is the short-form
name of the service being called.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.MaxErrorRetry">
<summary>
Gets and sets of the MaxErrorRetry property.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.LogResponse">
<summary>
Gets and sets the LogResponse.
If this property is set to true, the service response
is read in its entirety and logged.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.ReadEntireResponse">
<summary>
Gets and sets the ReadEntireResponse.
If this property is set to true, the service response
is read in its entirety before being processed.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.BufferSize">
<summary>
Gets and Sets the BufferSize property.
The BufferSize controls the buffer used to read in from input streams and write
out to the request.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.ProgressUpdateInterval">
<summary>
<para>
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.
</para>
<para>
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.
</para>
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.ResignRetries">
<summary>
Flag on whether to resign requests on retry or not.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.AllowAutoRedirect">
<summary>
This flag controls if .NET HTTP infrastructure should follow redirection
responses (e.g. HTTP 307 - temporary redirect).
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.LogMetrics">
<summary>
Flag on whether to log metrics for service calls.
This can be set in the application's configs, as below:
<code>
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSLogMetrics" value"true"/>
</appSettings>
</configuration>
</code>
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.DisableLogging">
<summary>
Gets and sets the DisableLogging. If true logging for this client will be disabled.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.ProxyCredentials">
<summary>
Credentials to use with a proxy.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.Timeout">
<summary>
Overrides the default request timeout value.
</summary>
<remarks>
<para>
If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used
to send requests.
</para>
<para>
Please specify a timeout value only if the operation will not complete within the default intervals
specified for an HttpWebRequest/HttpClient.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException">The timeout specified is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The timeout specified is less than or equal to zero and is not Infinite.</exception>
<seealso cref="P:System.Net.HttpWebRequest.Timeout"/>
<seealso cref="P:System.Net.Http.HttpClient.Timeout"/>
</member>
<member name="M:Amazon.Runtime.ClientConfig.SetUseNagleIfAvailable(System.Boolean)">
<summary>
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
</summary>
<param name="useNagle"></param>
</member>
<member name="M:Amazon.Runtime.ClientConfig.Validate">
<summary>
Performs validation on this config object.
Throws exception if any of the required values are missing/invalid.
</summary>
</member>
<member name="M:Amazon.Runtime.ClientConfig.GetTimeoutValue(System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
<summary>
Returns the request timeout value if its value is set,
else returns client timeout value.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.ProxyHost">
<summary>
Gets and sets of the ProxyHost property.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.ProxyPort">
<summary>
Gets and sets of the ProxyPort property.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.MaxIdleTime">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.ConnectionLimit">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.UseNagleAlgorithm">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.ClientConfig.ReadWriteTimeout">
<summary>
Overrides the default read-write timeout value.
</summary>
<remarks>
<para>
If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used
to send requests.
</para>
<exception cref="T:System.ArgumentNullException">The timeout specified is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The timeout specified is less than or equal to zero and is not Infinite.</exception>
</remarks>
<seealso cref="P:System.Net.HttpWebRequest.ReadWriteTimeout"/>
<seealso cref="P:System.Net.Http.WebRequestHandler.ReadWriteTimeout"/>
</member>
<member name="T:Amazon.Runtime.Internal.ClientContext">
<summary>
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.
</summary>
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.ClientContext.AddCustomAttributes(System.String,System.String)">
<summary>
Adds the custom attributes to the Client Context.
</summary>
<param name="key">Key.</param>
<param name="value">Value.</param>
</member>
<member name="M:Amazon.Runtime.Internal.ClientContext.ToJsonString">
<summary>
Gets a Json Representation of the Client Context.
</summary>
<returns>Json Representation of Client Context</returns>
</member>
<member name="M:Amazon.Runtime.Internal.AsyncResult.Dispose(System.Boolean)">
<summary>
Implements the Dispose pattern
</summary>
<param name="disposing">Whether this object is being disposed via a call to Dispose
or garbage collected.</param>
</member>
<member name="M:Amazon.Runtime.Internal.AsyncResult.Dispose">
<summary>
Disposes of all managed and unmanaged resources.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.DefaultRequest">
<summary>
Default implementation of the IRequest interface.
<para>
This class is only intended for internal use inside the AWS client libraries.
Callers shouldn't ever interact directly with objects of this class.
</para>
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.DefaultRequest.#ctor(Amazon.Runtime.AmazonWebServiceRequest,System.String)">
<summary>
Constructs a new DefaultRequest with the specified service name and the
original, user facing request object.
</summary>
<param name="request">The orignal request that is being wrapped</param>
<param name="serviceName">The service name</param>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.RequestName">
<summary>
The name of the request
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.HttpMethod">
<summary>
Gets and sets the type of http request to make, whether it should be POST,GET or DELETE
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.UseQueryString">
<summary>
Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.OriginalRequest">
<summary>
Returns the original, user facing request object which this internal
request object is representing.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.Headers">
<summary>
Returns a dictionary of the headers included in this request.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.Parameters">
<summary>
Returns a dictionary of the parameters included in this request.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.SubResources">
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.DefaultRequest.AddSubResource(System.String)">
<summary>
Adds a new null entry to the SubResources collection for the request
</summary>
<param name="subResource">The name of the subresource</param>
</member>
<member name="M:Amazon.Runtime.Internal.DefaultRequest.AddSubResource(System.String,System.String)">
<summary>
Adds a new entry to the SubResources collection for the request
</summary>
<param name="subResource">The name of the subresource</param>
<param name="value">Value of the entry</param>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.Endpoint">
<summary>
Gets and Sets the endpoint for this request.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.ResourcePath">
<summary>
Gets and Sets the resource path added on to the endpoint.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.Content">
<summary>
Gets and Sets the content for this request.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.SetContentFromParameters">
<summary>
Flag that signals that Content was and should be set
from the Parameters collection.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.ContentStream">
<summary>
Gets and sets the content stream.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.OriginalStreamPosition">
<summary>
Gets and sets the original stream position.
If ContentStream is null or does not support seek, this propery
should be equal to -1.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.DefaultRequest.ComputeContentStreamHash">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.ServiceName">
<summary>
The name of the service to which this request is being sent.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.AlternateEndpoint">
<summary>
Alternate endpoint to use for this request, if any.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.Suppress404Exceptions">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.AWS4SignerResult">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.UseChunkEncoding">
<summary>
Determine whether to use a chunked encoding upload for the request
(applies to Amazon S3 PutObject and UploadPart requests only).
</summary>
<returns></returns>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.CanonicalResourcePrefix">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.UseSigV4">
<summary>
This flag specifies if SigV4 is required for the current request.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRequest.AuthenticationRegion">
<summary>
The authentication region to use for the request.
Set from Config.AuthenticationRegion.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.DefaultRequest.IsRequestStreamRewindable">
<summary>
Checks if the request stream can be rewinded.
</summary>
<returns>Returns true if the request stream can be rewinded ,
else false.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.DefaultRequest.MayContainRequestBody">
<summary>
Returns true if the request can contain a request body, else false.
</summary>
<returns>Returns true if the currect request can contain a request body, else false.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.DefaultRequest.HasRequestBody">
<summary>
Returns true if the request has a body, else false.
</summary>
<returns>Returns true if the request has a body, else false.</returns>
</member>
<member name="T:Amazon.Runtime.Internal.IRequest">
<summary>
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.
<para>
This class is only intended for internal use inside the AWS client libraries.
Callers shouldn't ever interact directly with objects of this class.
</para>
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.RequestName">
<summary>
The name of the request
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.Headers">
<summary>
Returns a dictionary of the headers included in this request.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.UseQueryString">
<summary>
Gets and sets a flag that indicates whether the request is sent as a query string instead of the request body.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.Parameters">
<summary>
Returns a dictionary of the parameters included in this request.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.SubResources">
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.IRequest.AddSubResource(System.String)">
<summary>
Adds a new null entry to the SubResources collection for the request
</summary>
<param name="subResource">The name of the subresource</param>
</member>
<member name="M:Amazon.Runtime.Internal.IRequest.AddSubResource(System.String,System.String)">
<summary>
Adds a new entry to the SubResources collection for the request
</summary>
<param name="subResource">The name of the subresource</param>
<param name="value">Value of the entry</param>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.HttpMethod">
<summary>
Gets and sets the type of http request to make, whether it should be POST,GET or DELETE
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.Endpoint">
<summary>
Gets and Sets the endpoint for this request.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.ResourcePath">
<summary>
Gets and Sets the resource path added on to the endpoint.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.Content">
<summary>
Gets and Sets the content for this request.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.SetContentFromParameters">
<summary>
Flag that signals that Content was and should be set
from the Parameters collection.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.ContentStream">
<summary>
Gets and sets the content stream.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.OriginalStreamPosition">
<summary>
Gets and sets the original stream position.
If ContentStream is null or does not support seek, this propery
should be equal to -1.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.IRequest.ComputeContentStreamHash">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.ServiceName">
<summary>
The name of the service to which this request is being sent.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.OriginalRequest">
<summary>
Returns the original, user facing request object which this internal
request object is representing.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.AlternateEndpoint">
<summary>
Alternate endpoint to use for this request, if any.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.Suppress404Exceptions">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.AWS4SignerResult">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.UseChunkEncoding">
<summary>
Determine whether to use a chunked encoding upload for the request
(applies to Amazon S3 PutObject and UploadPart requests only).
</summary>
<returns></returns>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.CanonicalResourcePrefix">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.UseSigV4">
<summary>
This flag specifies if SigV4 is required for the current request.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.IRequest.AuthenticationRegion">
<summary>
The authentication region to use for the request.
Set from Config.AuthenticationRegion.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.IRequest.IsRequestStreamRewindable">
<summary>
Checks if the request stream can be rewinded.
</summary>
<returns>Returns true if the request stream can be rewinded ,
else false.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.IRequest.MayContainRequestBody">
<summary>
Returns true if the request can contain a request body, else false.
</summary>
<returns>Returns true if the currect request can contain a request body, else false.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.IRequest.HasRequestBody">
<summary>
Returns true if the request has a body, else false.
</summary>
<returns>Returns true if the request has a body, else false.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AbstractAWSSigner.ComputeHash(System.String,System.String,Amazon.Runtime.SigningAlgorithm)">
<summary>
Computes RFC 2104-compliant HMAC signature.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AbstractAWSSigner.ComputeHash(System.Byte[],System.String,Amazon.Runtime.SigningAlgorithm)">
<summary>
Computes RFC 2104-compliant HMAC signature.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AbstractAWSSigner.UseV4Signing(System.Boolean,Amazon.Runtime.Internal.IRequest,Amazon.Runtime.ClientConfig)">
<summary>
Inspects the supplied evidence to return the signer appropriate for the operation
</summary>
<param name="useSigV4Setting">Global setting for the service</param>
<param name="request">The request.</param>
<param name="config">Configuration for the client</param>
<returns>True if signature v4 request signing should be used</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS3Signer.Sign(Amazon.Runtime.Internal.IRequest,Amazon.Runtime.ClientConfig,Amazon.Runtime.Internal.Util.RequestMetrics,System.String,System.String)">
<summary>
Signs the specified request with the AWS3 signing protocol by using the
AWS account credentials given in the method parameters.
</summary>
<param name="awsAccessKeyId">The AWS public key</param>
<param name="awsSecretAccessKey">The AWS secret key used to sign the request in clear text</param>
<param name="metrics">Request metrics</param>
<param name="clientConfig">The configuration that specifies which hashing algorithm to use</param>
<param name="request">The request to have the signature compute for</param>
<exception cref="T:Amazon.Runtime.SignatureException">If any problems are encountered while signing the request</exception>
</member>
<member name="T:Amazon.Runtime.Internal.Auth.AWS4Signer">
<summary>
AWS4 protocol signer for service calls that transmit authorization in the header field "Authorization".
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.Sign(Amazon.Runtime.Internal.IRequest,Amazon.Runtime.ClientConfig,Amazon.Runtime.Internal.Util.RequestMetrics,System.String,System.String)">
<summary>
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.
</summary>
<param name="request">
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.
</param>
<param name="clientConfig">
Client configuration data encompassing the service call (notably authentication
region, endpoint and service name).
</param>
<param name="metrics">
Metrics for the request
</param>
<param name="awsAccessKeyId">
The AWS public key for the account making the service call.
</param>
<param name="awsSecretAccessKey">
The AWS secret key for the account making the call, in clear text.
</param>
<exception cref="T:Amazon.Runtime.SignatureException">
If any problems are encountered while signing the request.
</exception>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.SignRequest(Amazon.Runtime.Internal.IRequest,Amazon.Runtime.ClientConfig,Amazon.Runtime.Internal.Util.RequestMetrics,System.String,System.String)">
<summary>
Calculates and signs the specified request using the AWS4 signing protocol by using the
AWS account credentials given in the method parameters.
</summary>
<param name="request">
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.
</param>
<param name="clientConfig">
Client configuration data encompassing the service call (notably authentication
region, endpoint and service name).
</param>
<param name="metrics">
Metrics for the request.
</param>
<param name="awsAccessKeyId">
The AWS public key for the account making the service call.
</param>
<param name="awsSecretAccessKey">
The AWS secret key for the account making the call, in clear text.
</param>
<exception cref="T:Amazon.Runtime.SignatureException">
If any problems are encountered while signing the request.
</exception>
<remarks>
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.
</remarks>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.InitializeHeaders(System.Collections.Generic.IDictionary{System.String,System.String},System.Uri)">
<summary>
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.
</summary>
<param name="headers">The current set of headers</param>
<param name="requestEndpoint"></param>
<returns>Date and time used for x-amz-date, in UTC</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.InitializeHeaders(System.Collections.Generic.IDictionary{System.String,System.String},System.Uri,System.DateTime)">
<summary>
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.
</summary>
<param name="headers">The current set of headers</param>
<param name="requestEndpoint"></param>
<param name="requestDateTime"></param>
<returns>Date and time used for x-amz-date, in UTC</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.ComputeSignature(Amazon.Runtime.ImmutableCredentials,System.String,System.DateTime,System.String,System.String,System.String)">
<summary>
Computes and returns an AWS4 signature for the specified canonicalized request
</summary>
<param name="credentials"></param>
<param name="region"></param>
<param name="signedAt"></param>
<param name="service"></param>
<param name="signedHeaders"></param>
<param name="canonicalRequest"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.ComputeSignature(System.String,System.String,System.String,System.DateTime,System.String,System.String,System.String)">
<summary>
Computes and returns an AWS4 signature for the specified canonicalized request
</summary>
<param name="awsAccessKey"></param>
<param name="awsSecretAccessKey"></param>
<param name="region"></param>
<param name="signedAt"></param>
<param name="service"></param>
<param name="signedHeaders"></param>
<param name="canonicalRequest"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.ComputeSignature(System.String,System.String,System.String,System.DateTime,System.String,System.String,System.String,Amazon.Runtime.Internal.Util.RequestMetrics)">
<summary>
Computes and returns an AWS4 signature for the specified canonicalized request
</summary>
<param name="awsAccessKey"></param>
<param name="awsSecretAccessKey"></param>
<param name="region"></param>
<param name="signedAt"></param>
<param name="service"></param>
<param name="signedHeaders"></param>
<param name="canonicalRequest"></param>
<param name="metrics"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.FormatDateTime(System.DateTime,System.String)">
<summary>
Formats the supplied date and time for use in AWS4 signing, where various formats are used.
</summary>
<param name="dt"></param>
<param name="formatString">The required format</param>
<returns>The UTC date/time in the requested format</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.ComposeSigningKey(System.String,System.String,System.String,System.String)">
<summary>
Compute and return the multi-stage signing key for the request.
</summary>
<param name="awsSecretAccessKey">The clear-text AWS secret key, if not held in secureKey</param>
<param name="region">The region in which the service request will be processed</param>
<param name="date">Date of the request, in yyyyMMdd format</param>
<param name="service">The name of the service being called by the request</param>
<returns>Computed signing key</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.SetRequestBodyHash(Amazon.Runtime.Internal.IRequest)">
<summary>
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.
</summary>
<param name="request"></param>
<returns>
The computed hash, whether already set in headers or computed here. Null
if we were not able to compute a hash.
</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.SignBlob(System.Byte[],System.String)">
<summary>
Returns the HMAC256 for an arbitrary blob using the specified key
</summary>
<param name="key"></param>
<param name="data"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.SignBlob(System.Byte[],System.Byte[])">
<summary>
Returns the HMAC256 for an arbitrary blob using the specified key
</summary>
<param name="key"></param>
<param name="data"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.ComputeKeyedHash(Amazon.Runtime.SigningAlgorithm,System.Byte[],System.String)">
<summary>
Compute and return the hash of a data blob using the specified key
</summary>
<param name="algorithm">Algorithm to use for hashing</param>
<param name="key">Hash key</param>
<param name="data">Data blob</param>
<returns>Hash of the data</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.ComputeKeyedHash(Amazon.Runtime.SigningAlgorithm,System.Byte[],System.Byte[])">
<summary>
Compute and return the hash of a data blob using the specified key
</summary>
<param name="algorithm">Algorithm to use for hashing</param>
<param name="key">Hash key</param>
<param name="data">Data blob</param>
<returns>Hash of the data</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.ComputeHash(System.String)">
<summary>
Computes the non-keyed hash of the supplied data
</summary>
<param name="data"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.ComputeHash(System.Byte[])">
<summary>
Computes the non-keyed hash of the supplied data
</summary>
<param name="data"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.CanonicalizeRequest(System.Uri,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.String)">
<summary>
Computes and returns the canonical request
</summary>
<param name="endpoint">The endpoint URL</param>
<param name="resourcePath">the path of the resource being operated on</param>
<param name="httpMethod">The http method used for the request</param>
<param name="sortedHeaders">The full request headers, sorted into canonical order</param>
<param name="canonicalQueryString">The query parameters for the request</param>
<param name="precomputedBodyHash">
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.
</param>
<returns>Canonicalised request as a string</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.SortHeaders(System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Reorders the headers for the request for canonicalization.
</summary>
<param name="requestHeaders">The set of proposed headers for the request</param>
<returns>List of headers that must be included in the signature</returns>
<remarks>For AWS4 signing, all headers are considered viable for inclusion</remarks>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.CanonicalizeHeaders(System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Computes the canonical headers with values for the request. Only headers included in the signature
are included in the canonicalization process.
</summary>
<param name="sortedHeaders">All request headers, sorted into canonical order</param>
<returns>Canonicalized string of headers, with the header names in lower case.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.CanonicalizeHeaderNames(System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Returns the set of headers included in the signature as a flattened, ;-delimited string
</summary>
<param name="sortedHeaders">The headers included in the signature</param>
<returns>Formatted string of header names</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.GetParametersToCanonicalize(Amazon.Runtime.Internal.IRequest)">
<summary>
Collects the subresource and query string parameters into one collection
ready for canonicalization
</summary>
<param name="request">The in-flight request being signed</param>
<returns>The fused set of parameters</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.CanonicalizeQueryParameters(System.String,System.Boolean)">
<summary>
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.
</summary>
<param name="queryString">The set of parameters being passed on the uri</param>
<param name="uriEncodeParameters">
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.
</param>
<returns>The uri encoded query string parameters in canonical ordering</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.CanonicalizeQueryParameters(System.Collections.Generic.IDictionary{System.String,System.String},System.Boolean)">
<summary>
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.
</summary>
<param name="parameters">The set of parameters to be encoded in the query string</param>
<param name="uriEncodeParameters">
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.
</param>
<returns>The uri encoded query string parameters in canonical ordering</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4Signer.GetRequestPayloadBytes(Amazon.Runtime.Internal.IRequest)">
<summary>
Returns the request parameters in the form of a query string.
</summary>
<param name="request">The request instance</param>
<returns>Request parameters in query string format</returns>
</member>
<member name="T:Amazon.Runtime.Internal.Auth.AWS4PreSignedUrlSigner">
<summary>
AWS4 protocol signer for Amazon S3 presigned urls.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4PreSignedUrlSigner.Sign(Amazon.Runtime.Internal.IRequest,Amazon.Runtime.ClientConfig,Amazon.Runtime.Internal.Util.RequestMetrics,System.String,System.String)">
<summary>
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'.
</summary>
<param name="request">
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.
</param>
<param name="clientConfig">
Adding supporting data for the service call required by the signer (notably authentication
region, endpoint and service name).
</param>
<param name="metrics">
Metrics for the request
</param>
<param name="awsAccessKeyId">
The AWS public key for the account making the service call.
</param>
<param name="awsSecretAccessKey">
The AWS secret key for the account making the call, in clear text
</param>
<exception cref="T:Amazon.Runtime.SignatureException">
If any problems are encountered while signing the request.
</exception>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4PreSignedUrlSigner.SignRequest(Amazon.Runtime.Internal.IRequest,Amazon.Runtime.ClientConfig,Amazon.Runtime.Internal.Util.RequestMetrics,System.String,System.String)">
<summary>
Calculates the AWS4 signature for a presigned url.
</summary>
<param name="request">
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.
</param>
<param name="clientConfig">
Adding supporting data for the service call required by the signer (notably authentication
region, endpoint and service name).
</param>
<param name="metrics">
Metrics for the request
</param>
<param name="awsAccessKeyId">
The AWS public key for the account making the service call.
</param>
<param name="awsSecretAccessKey">
The AWS secret key for the account making the call, in clear text
</param>
<exception cref="T:Amazon.Runtime.SignatureException">
If any problems are encountered while signing the request.
</exception>
<remarks>
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.
</remarks>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4PreSignedUrlSigner.SignRequest(Amazon.Runtime.Internal.IRequest,Amazon.Runtime.ClientConfig,Amazon.Runtime.Internal.Util.RequestMetrics,System.String,System.String,System.String,System.String)">
<summary>
Calculates the AWS4 signature for a presigned url.
</summary>
<param name="request">
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.
</param>
<param name="clientConfig">
Adding supporting data for the service call required by the signer (notably authentication
region, endpoint and service name).
</param>
<param name="metrics">
Metrics for the request
</param>
<param name="awsAccessKeyId">
The AWS public key for the account making the service call.
</param>
<param name="awsSecretAccessKey">
The AWS secret key for the account making the call, in clear text
</param>
<param name="service">
The service to sign for
</param>
<param name="overrideSigningRegion">
The region to sign to, if null then the region the client is configured for will be used.
</param>
<exception cref="T:Amazon.Runtime.SignatureException">
If any problems are encountered while signing the request.
</exception>
<remarks>
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.
</remarks>
</member>
<member name="T:Amazon.Runtime.Internal.Auth.AWS4SigningResult">
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.AWS4SigningResult.#ctor(System.String,System.DateTime,System.String,System.String,System.Byte[],System.Byte[])">
<summary>
Constructs a new signing result instance for a computed signature
</summary>
<param name="awsAccessKeyId">The access key that was included in the signature</param>
<param name="signedAt">Date/time (UTC) that the signature was computed</param>
<param name="signedHeaders">The collection of headers names that were included in the signature</param>
<param name="scope">Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request)</param>
<param name="signingKey">Returns the key that was used to compute the signature</param>
<param name="signature">Computed signature</param>
</member>
<member name="P:Amazon.Runtime.Internal.Auth.AWS4SigningResult.AccessKeyId">
<summary>
The access key that was used in signature computation.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Auth.AWS4SigningResult.ISO8601DateTime">
<summary>
ISO8601 formatted date/time that the signature was computed
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Auth.AWS4SigningResult.ISO8601Date">
<summary>
ISO8601 formatted date that the signature was computed
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Auth.AWS4SigningResult.SignedHeaders">
<summary>
The ;-delimited collection of header names that were included in the signature computation
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Auth.AWS4SigningResult.Scope">
<summary>
Formatted 'scope' value for signing (YYYYMMDD/region/service/aws4_request)
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Auth.AWS4SigningResult.SigningKey">
<summary>
Returns a copy of the key that was used to compute the signature
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Auth.AWS4SigningResult.Signature">
<summary>
Returns the hex string representing the signature
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Auth.AWS4SigningResult.SignatureBytes">
<summary>
Returns a copy of the byte array containing the signature
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Auth.AWS4SigningResult.ForAuthorizationHeader">
<summary>
Returns the signature in a form usable as an 'Authorization' header value.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Auth.AWS4SigningResult.ForQueryParameters">
<summary>
Returns the signature in a form usable as a set of query string parameters.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Auth.NullSigner">
<summary>
Null Signer which does a no-op.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Auth.QueryStringSigner.Sign(Amazon.Runtime.Internal.IRequest,Amazon.Runtime.ClientConfig,Amazon.Runtime.Internal.Util.RequestMetrics,System.String,System.String)">
<summary>
Signs the specified request with the AWS2 signing protocol by using the
AWS account credentials given in the method parameters.
</summary>
<param name="awsAccessKeyId">The AWS public key</param>
<param name="awsSecretAccessKey">The AWS secret key used to sign the request in clear text</param>
<param name="metrics">Request metrics</param>
<param name="clientConfig">The configuration that specifies which hashing algorithm to use</param>
<param name="request">The request to have the signature compute for</param>
<exception cref="T:Amazon.Runtime.SignatureException">If any problems are encountered while signing the request</exception>
</member>
<member name="T:Amazon.Runtime.Internal.Auth.SignatureException">
<summary>
This exception is thrown if there are problems signing the request.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.ErrorResponseUnmarshaller">
<summary>
Response Unmarshaller for all Errors
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.ErrorResponseUnmarshaller.Unmarshall(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext)">
<summary>
Build an ErrorResponse from XML
</summary>
<param name="context">The XML parsing context.
Usually an <c>Amazon.Runtime.Internal.UnmarshallerContext</c>.</param>
<returns>An <c>ErrorResponse</c> object.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.ErrorResponseUnmarshaller.GetInstance">
<summary>
Return an instance of and ErrorResponseUnmarshaller.
</summary>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.IResponseUnmarshaller`2">
<summary>
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.
</summary>
<typeparam name="T">The type of object the unmarshaller returns</typeparam>
<typeparam name="R">The type of the XML unmashaller context, which contains the
state of parsing the XML stream. Uaually an instance of
<c>Amazon.Runtime.Internal.Transform.UnmarshallerContext</c>.</typeparam>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.IResponseUnmarshaller`2.UnmarshallException(`1,System.Exception,System.Net.HttpStatusCode)">
<summary>
Extracts an exeption with data from an ErrorResponse.
</summary>
<param name="input">The XML parsing context.</param>
<param name="innerException">An inner exception to be included with the returned exception</param>
<param name="statusCode">The HttpStatusCode from the ErrorResponse</param>
<returns>Either an exception based on the ErrorCode from the ErrorResponse, or the
general service exception for the service in question.</returns>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.IUnmarshaller`2">
<summary>
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.
</summary>
<typeparam name="T">The type of object the unmarshaller returns</typeparam>
<typeparam name="R">The type of the XML unmashaller context, which contains the
state during parsing of the XML stream. Usually an instance of
<c>Amazon.Runtime.Internal.Transform.UnmarshallerContext</c>.</typeparam>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.IUnmarshaller`2.Unmarshall(`1)">
<summary>
Given the current position in the XML stream, extract a T.
</summary>
<param name="input">The XML parsing context</param>
<returns>An object of type T populated with data from the XML stream.</returns>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.JsonErrorResponseUnmarshaller">
<summary>
Response Unmarshaller for all Errors
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.JsonErrorResponseUnmarshaller.Unmarshall(Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext)">
<summary>
Build an ErrorResponse from json
</summary>
<param name="context">The json parsing context.
Usually an <c>Amazon.Runtime.Internal.JsonUnmarshallerContext</c>.</param>
<returns>An <c>ErrorResponse</c> object.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.JsonErrorResponseUnmarshaller.GetInstance">
<summary>
Return an instance of JsonErrorResponseUnmarshaller.
</summary>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext">
<summary>
Wraps a json string for unmarshalling.
Each <c>Read()</c> operation gets the next token.
<c>TestExpression()</c> is used to match the current key-chain
to an xpath expression. The general pattern looks like this:
<code>
JsonUnmarshallerContext context = new JsonUnmarshallerContext(jsonString);
while (context.Read())
{
if (context.IsKey)
{
if (context.TestExpresion("path/to/element"))
{
myObject.stringMember = stringUnmarshaller.GetInstance().Unmarshall(context);
continue;
}
}
}
</code>
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext.#ctor(System.IO.Stream,System.Boolean,Amazon.Runtime.Internal.Transform.IWebResponseData)">
<summary>
Wrap the jsonstring for unmarshalling.
</summary>
<param name="responseStream">Stream that contains the JSON for unmarshalling</param>
<param name="maintainResponseBody"> If set to true, maintains a copy of the complete response body as the stream is being read.</param>
<param name="responseData">Response data coming back from the request</param>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext.IsStartOfDocument">
<summary>
Are we at the start of the json document.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext.IsEndElement">
<summary>
Is the current token the end of an object
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext.IsStartElement">
<summary>
Is the current token the start of an object
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext.CurrentDepth">
<summary>
Returns the element depth of the parser's current position in the json
document being parsed.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext.CurrentPath">
<summary>
The current Json path that is being unmarshalled.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext.Read">
<summary>
Reads to the next token in the json document, and updates the context
accordingly.
</summary>
<returns>
True if a token was read, false if there are no more tokens to read.
</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext.Peek(ThirdParty.Json.LitJson.JsonToken)">
<summary>
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.
</summary>
<param name="token">Token to peek.</param>
<returns>Returns true if the peeked token matches given token.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext.ReadText">
<summary>
Returns the text contents of the current token being parsed.
</summary>
<returns>
The text contents of the current token being parsed.
</returns>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext.CurrentTokenType">
<summary>
The type of the current token
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext.Stream">
<summary>
Get the base stream of the jsonStream.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext.Peek">
<summary>
Peeks at the next (non-whitespace) character in the jsonStream.
</summary>
<returns>The next (non-whitespace) character in the jsonStream, or -1 if at the end.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext.StreamPeek">
<summary>
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.
</summary>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.ResponseUnmarshaller">
<summary>
Abstract class for unmarshalling service responses.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.XmlResponseUnmarshaller">
<summary>
Class for unmarshalling XML service responses.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.EC2ResponseUnmarshaller">
<summary>
Class for unmarshalling EC2 service responses.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.JsonResponseUnmarshaller">
<summary>
Class for unmarshalling JSON service responses.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.IntUnmarshaller">
<summary>
Unmarshaller for int fields
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.LongUnmarshaller">
<summary>
Unmarshaller for long fields
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.FloatUnmarshaller">
<summary>
Unmarshaller for float fields
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.DoubleUnmarshaller">
<summary>
Unmarshaller for double fields
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.BoolUnmarshaller">
<summary>
Unmarshaller for bool fields
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.StringUnmarshaller">
<summary>
Unmarshaller for string fields
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.ByteUnmarshaller">
<summary>
Unmarshaller for byte fields
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.DateTimeUnmarshaller">
<summary>
Unmarshaller for DateTime fields
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.MemoryStreamUnmarshaller">
<summary>
Unmarshaller for MemoryStream fields
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.ResponseMetadataUnmarshaller">
<summary>
Unmarshaller for ResponseMetadata
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.UnmarshallerContext">
<summary>
Base class for the UnmarshallerContext objects that are used
to unmarshall a web-service response.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.UnmarshallerContext.TestExpression(System.String)">
<summary>
Tests the specified expression against the current position in the XML
document </summary>
<param name="expression">
The pseudo-XPath expression to test.</param>
<returns>
True if the expression matches the current position in the document,
false otherwise.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.UnmarshallerContext.TestExpression(System.String,System.Int32)">
<summary>
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. </summary>
<param name="expression">
The pseudo-XPath expression to test.</param>
<param name="startingStackDepth">
The depth in the stack representing where the expression must
start matching in order for this method to return true. </param>
<returns>
True if the specified expression matches the current position in
the XML document, starting from the specified depth. </returns>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.UnmarshallerContext.ReadAtDepth(System.Int32)">
<summary>
Reads the next token at depth greater than or equal to target depth.
</summary>
<param name="targetDepth">Tokens are read at depth greater than or equal to target depth.</param>
<returns>True if a token was read and current depth is greater than or equal to target depth.</returns>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.UnmarshallerContext.CurrentPath">
<summary>
The current path that is being unmarshalled.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.UnmarshallerContext.CurrentDepth">
<summary>
Returns the element depth of the parser's current position in the
document being parsed.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.UnmarshallerContext.Read">
<summary>
Reads to the next node in the document, and updates the context accordingly.
</summary>
<returns>
True if a node was read, false if there are no more elements to read.
</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.UnmarshallerContext.ReadText">
<summary>
Returns the text contents of the current element being parsed.
</summary>
<returns>
The text contents of the current element being parsed.
</returns>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.UnmarshallerContext.IsStartElement">
<summary>
True if <c>NodeType</c> is <c>Element</c>.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.UnmarshallerContext.IsEndElement">
<summary>
True if <c>NodeType</c> is <c>EndElement</c>.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.UnmarshallerContext.IsStartOfDocument">
<summary>
True if the context is at the start of the document.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.UnmarshallerContext.Dispose(System.Boolean)">
<summary>
Implements the Dispose pattern
</summary>
<param name="disposing">Whether this object is being disposed via a call to Dispose
or garbage collected.</param>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.UnmarshallerContext.Dispose">
<summary>
Disposes of all managed and unmanaged resources.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext">
<summary>
Wrap an <c>XmltextReader</c> for simulating an event stream.
Each <c>Read()</c> operation goes either to the next element or next attribute within
the current element. <c>TestExpression()</c> is used to match the current event
to an xpath expression. The general pattern looks like this:
<code>
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);
}
</code>
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext.#ctor(System.IO.Stream,System.Boolean,Amazon.Runtime.Internal.Transform.IWebResponseData)">
<summary>
Wrap an XmlTextReader with state for event-based parsing of an XML stream.
</summary>
<param name="responseStream"><c>Stream</c> with the XML from a service response.</param>
<param name="maintainResponseBody"> If set to true, maintains a copy of the complete response body as the stream is being read.</param>
<param name="responseData">Response data coming back from the request</param>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext.CurrentPath">
<summary>
The current XML path that is being unmarshalled.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext.CurrentDepth">
<summary>
Returns the element depth of the parser's current position in the XML
document being parsed.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext.Read">
<summary>
Reads to the next node in the XML document, and updates the context accordingly.
</summary>
<returns>
True if a node was read, false if there are no more elements to read./
</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext.ReadText">
<summary>
Returns the text contents of the current element being parsed.
</summary>
<returns>
The text contents of the current element being parsed.
</returns>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext.IsStartElement">
<summary>
True if <c>NodeType</c> is <c>Element</c>.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext.IsEndElement">
<summary>
True if <c>NodeType</c> is <c>EndElement</c>.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext.IsStartOfDocument">
<summary>
True if the context is at the start of the document.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext.IsAttribute">
<summary>
True if <c>NodeType</c> is <c>Attribute</c>.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.EC2UnmarshallerContext.#ctor(System.IO.Stream,System.Boolean,Amazon.Runtime.Internal.Transform.IWebResponseData)">
<summary>
Wrap an XmlTextReader with state for event-based parsing of an XML stream.
</summary>
<param name="responseStream"><c>Stream</c> with the XML from a service response.</param>
<param name="maintainResponseBody"> If set to true, maintains a copy of the complete response body as the stream is being read.</param>
<param name="responseData">Response data coming back from the request</param>
</member>
<member name="P:Amazon.Runtime.Internal.Transform.EC2UnmarshallerContext.RequestId">
<summary>
RequestId value, if found in response
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Transform.EC2UnmarshallerContext.Read">
<summary>
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.
</summary>
<returns>
True if a node was read, false if there are no more elements to read./
</returns>
</member>
<member name="T:Amazon.Runtime.Internal.Util.CachingWrapperStream">
<summary>
A stream which caches the contents of the underlying stream as it reads it.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.CachingWrapperStream.AllReadBytes">
<summary>
All the bytes read by the stream.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.CachingWrapperStream.#ctor(System.IO.Stream,System.Int32)">
<summary>
Initializes the CachingWrapperStream with a base stream.
</summary>
<param name="baseStream">The stream to be wrapped.</param>
<param name="cacheLimit">Maximum number of bytes to be cached.</param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.CachingWrapperStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Reads a sequence of bytes from the current stream and advances the position
within the stream by the number of bytes read.
</summary>
<param name="buffer">
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.
</param>
<param name="offset">
The zero-based byte offset in buffer at which to begin storing the data read
from the current stream.
</param>
<param name="count">
The maximum number of bytes to be read from the current stream.
</param>
<returns>
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.
</returns>
</member>
<member name="P:Amazon.Runtime.Internal.Util.CachingWrapperStream.CanSeek">
<summary>
Gets a value indicating whether the current stream supports seeking.
CachingWrapperStream does not support seeking, this will always be false.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.CachingWrapperStream.Position">
<summary>
Gets or sets the position within the current stream.
CachingWrapperStream does not support seeking, attempting to set Position
will throw NotSupportedException.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.CachingWrapperStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Sets the position within the current stream.
CachingWrapperStream does not support seeking, attempting to call Seek
will throw NotSupportedException.
</summary>
<param name="offset">A byte offset relative to the origin parameter.</param>
<param name="origin">
A value of type System.IO.SeekOrigin indicating the reference point used
to obtain the new position.</param>
<returns>The new position within the current stream.</returns>
</member>
<member name="T:Amazon.Runtime.Internal.Util.ChunkedUploadWrapperStream">
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.ChunkedUploadWrapperStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Reads some or all of the processed chunk to the consumer, constructing
and streaming a new chunk if more input data is available.
</summary>
<param name="buffer"></param>
<param name="offset"></param>
<param name="count"></param>
<returns></returns>
</member>
<member name="P:Amazon.Runtime.Internal.Util.ChunkedUploadWrapperStream.HeaderSigningResult">
<summary>
Results of the header-signing portion of the request
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.ChunkedUploadWrapperStream.PreviousChunkSignature">
<summary>
Computed signature of the chunk prior to the one in-flight, in
hex
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.ChunkedUploadWrapperStream.ConstructOutputBufferChunk(System.Int32)">
<summary>
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.
</summary>
<param name="dataLen"></param>
</member>
<member name="P:Amazon.Runtime.Internal.Util.ChunkedUploadWrapperStream.Length">
<summary>
Length override to return the true length of the payload plus the metainfo
supplied with each chunk
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.ChunkedUploadWrapperStream.ComputeChunkedContentLength(System.Int64)">
<summary>
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.
</summary>
<param name="originalLength"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.ChunkedUploadWrapperStream.CalculateChunkHeaderLength(System.Int64)">
<summary>
Computes the size of the header data for each chunk.
</summary>
<param name="chunkDataSize"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.ChunkedUploadWrapperStream.FillInputBuffer">
<summary>
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
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.AlwaysSendList`1">
<summary>
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.
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:Amazon.Runtime.Internal.Util.AlwaysSendDictionary`2">
<summary>
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.
</summary>
<typeparam name="TKey"></typeparam>
<typeparam name="TValue"></typeparam>
</member>
<member name="T:Amazon.Runtime.Internal.Util.BackgroundDispatcher`1">
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.BackgroundDispatcher`1.Dispose(System.Boolean)">
<summary>
Implements the Dispose pattern
</summary>
<param name="disposing">Whether this object is being disposed via a call to Dispose
or garbage collected.</param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.BackgroundDispatcher`1.Dispose">
<summary>
Disposes of all managed and unmanaged resources.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.BackgroundInvoker">
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.Extensions.HasRequestData(Amazon.Runtime.Internal.IRequest)">
<summary>
Returns true if the Content is set or there are
query parameters.
</summary>
<param name="request">This request</param>
<returns>True if data is present; false otherwise.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.Hashing.Hash(System.Object[])">
<summary>
Hashes a set of objects.
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.Hashing.CombineHashes(System.Int32[])">
<summary>
Combines a set of hashses.
</summary>
<param name="hashes"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.Hashing.CombineHashesInternal(System.Int32,System.Int32)">
<summary>
Combines two hashes.
</summary>
<param name="a"></param>
<param name="b"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.HashingWrapper.Dispose">
<summary>
Disposes of all managed and unmanaged resources.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.HashingWrapper.Dispose(System.Boolean)">
<summary>
Implements the Dispose pattern
</summary>
<param name="disposing">Whether this object is being disposed via a call to Dispose
or garbage collected.</param>
</member>
<member name="T:Amazon.Runtime.Internal.Util.HashStream">
<summary>
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.
</summary>
<exception cref="T:Amazon.Runtime.AmazonClientException">
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.
</exception>
</member>
<member name="P:Amazon.Runtime.Internal.Util.HashStream.Algorithm">
<summary>
Algorithm to use to calculate hash.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.HashStream.FinishedHashing">
<summary>
True if hashing is finished and no more hashing should be done;
otherwise false.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.HashStream.CurrentPosition">
<summary>
Current position in the stream.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.HashStream.CalculatedHash">
<summary>
Calculated hash for the stream.
This value is set only after the stream is closed.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.HashStream.ExpectedHash">
<summary>
Expected hash value. Compared against CalculatedHash upon Close().
If the hashes are different, an AmazonClientException is thrown.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.HashStream.ExpectedLength">
<summary>
Expected length of stream.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.HashStream.#ctor(System.IO.Stream,System.Byte[],System.Int64)">
<summary>
Initializes an HashStream with a hash algorithm and a base stream.
</summary>
<param name="baseStream">Stream to calculate hash for.</param>
<param name="expectedHash">
Expected hash. Will be compared against calculated hash on stream close.
Pass in null to disable check.
</param>
<param name="expectedLength">
Expected length of the stream. If the reading stops before reaching this
position, CalculatedHash will be set to empty array.
</param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.HashStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Reads a sequence of bytes from the current stream and advances the position
within the stream by the number of bytes read.
</summary>
<param name="buffer">
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.
</param>
<param name="offset">
The zero-based byte offset in buffer at which to begin storing the data read
from the current stream.
</param>
<param name="count">
The maximum number of bytes to be read from the current stream.
</param>
<returns>
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.
</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.HashStream.Close">
<summary>
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.
</summary>
<exception cref="T:Amazon.Runtime.AmazonClientException">
If ExpectedHash is set and is different from CalculateHash that the stream calculates.
</exception>
</member>
<member name="P:Amazon.Runtime.Internal.Util.HashStream.CanSeek">
<summary>
Gets a value indicating whether the current stream supports seeking.
HashStream does not support seeking, this will always be false.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.HashStream.Position">
<summary>
Gets or sets the position within the current stream.
HashStream does not support seeking, attempting to set Position
will throw NotSupportedException.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.HashStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Sets the position within the current stream.
HashStream does not support seeking, attempting to call Seek
will throw NotSupportedException.
</summary>
<param name="offset">A byte offset relative to the origin parameter.</param>
<param name="origin">
A value of type System.IO.SeekOrigin indicating the reference point used
to obtain the new position.</param>
<returns>The new position within the current stream.</returns>
</member>
<member name="P:Amazon.Runtime.Internal.Util.HashStream.Length">
<summary>
Gets the overridden length used to construct the HashStream
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.HashStream.CalculateHash">
<summary>
Calculates the hash for the stream so far and disables any further
hashing.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.HashStream.Reset">
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.HashStream.ValidateBaseStream">
<summary>
Validates the underlying stream.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.HashStream.CompareHashes(System.Byte[],System.Byte[])">
<summary>
Compares two hashes (arrays of bytes).
</summary>
<param name="expected">Expected hash.</param>
<param name="actual">Actual hash.</param>
<returns>
True if the hashes are identical; otherwise false.
</returns>
</member>
<member name="T:Amazon.Runtime.Internal.Util.HashStream`1">
<summary>
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.
</summary>
<exception cref="T:Amazon.Runtime.AmazonClientException">
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.
</exception>
</member>
<member name="M:Amazon.Runtime.Internal.Util.HashStream`1.#ctor(System.IO.Stream,System.Byte[],System.Int64)">
<summary>
Initializes an HashStream with a hash algorithm and a base stream.
</summary>
<param name="baseStream">Stream to calculate hash for.</param>
<param name="expectedHash">
Expected hash. Will be compared against calculated hash on stream close.
Pass in null to disable check.
</param>
<param name="expectedLength">
Expected length of the stream. If the reading stops before reaching this
position, CalculatedHash will be set to empty array.
</param>
</member>
<member name="T:Amazon.Runtime.Internal.Util.MD5Stream">
<summary>
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.
</summary>
<exception cref="T:Amazon.Runtime.AmazonClientException">
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.
</exception>
</member>
<member name="M:Amazon.Runtime.Internal.Util.MD5Stream.#ctor(System.IO.Stream,System.Byte[],System.Int64)">
<summary>
Initializes an MD5Stream with a base stream.
</summary>
<param name="baseStream">Stream to calculate hash for.</param>
<param name="expectedHash">
Expected hash. Will be compared against calculated hash on stream close.
Pass in null to disable check.
</param>
<param name="expectedLength">
Expected length of the stream. If the reading stops before reaching this
position, CalculatedHash will be set to empty array.
</param>
</member>
<member name="T:Amazon.Runtime.Internal.Util.LogMessage">
<summary>
A single logged message
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.Logger">
<summary>
This is a dynamic wrapper around log4net so we can avoid log4net being required
to be distributed with the SDK.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.InternalLogger">
<summary>
Abstract logger class, base for any custom/specific loggers.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.InternalLogger.Flush">
<summary>
Flushes the logger contents.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.InternalLogger.IsErrorEnabled">
<summary>
Simple wrapper around the log4net IsErrorEnabled property.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.InternalLogger.IsDebugEnabled">
<summary>
Simple wrapper around the log4net IsDebugEnabled property.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.InternalLogger.IsInfoEnabled">
<summary>
Simple wrapper around the log4net IsInfoEnabled property.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.InternalLogger.Error(System.Exception,System.String,System.Object[])">
<summary>
Simple wrapper around the log4net Error method.
</summary>
<param name="exception"></param>
<param name="messageFormat"></param>
<param name="args"></param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.InternalLogger.Debug(System.Exception,System.String,System.Object[])">
<summary>
Simple wrapper around the log4net Debug method.
</summary>
<param name="exception"></param>
<param name="messageFormat"></param>
<param name="args"></param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.InternalLogger.DebugFormat(System.String,System.Object[])">
<summary>
Simple wrapper around the log4net DebugFormat method.
</summary>
<param name="message"></param>
<param name="arguments"></param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.InternalLogger.InfoFormat(System.String,System.Object[])">
<summary>
Simple wrapper around the log4net InfoFormat method.
</summary>
<param name="message"></param>
<param name="arguments"></param>
</member>
<member name="T:Amazon.Runtime.Internal.Util.InternalLog4netLogger">
<summary>
Logger wrapper for reflected log4net logging methods.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.InternalLog4netLogger.loadStatics">
<summary>
This should be a one time call to use reflection to find all the types and methods
needed for the logging API.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.InternalLog4netLogger.IsErrorEnabled">
<summary>
Simple wrapper around the log4net IsErrorEnabled property.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.InternalLog4netLogger.Error(System.Exception,System.String,System.Object[])">
<summary>
Simple wrapper around the log4net Error method.
</summary>
<param name="exception"></param>
<param name="messageFormat"></param>
<param name="args"></param>
</member>
<member name="P:Amazon.Runtime.Internal.Util.InternalLog4netLogger.IsDebugEnabled">
<summary>
Simple wrapper around the log4net IsDebugEnabled property.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.InternalLog4netLogger.Debug(System.Exception,System.String,System.Object[])">
<summary>
Simple wrapper around the log4net Debug method.
</summary>
<param name="exception"></param>
<param name="messageFormat"></param>
<param name="args"></param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.InternalLog4netLogger.DebugFormat(System.String,System.Object[])">
<summary>
Simple wrapper around the log4net DebugFormat method.
</summary>
<param name="message"></param>
<param name="arguments"></param>
</member>
<member name="P:Amazon.Runtime.Internal.Util.InternalLog4netLogger.IsInfoEnabled">
<summary>
Simple wrapper around the log4net IsInfoEnabled property.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.InternalLog4netLogger.InfoFormat(System.String,System.Object[])">
<summary>
Simple wrapper around the log4net InfoFormat method.
</summary>
<param name="message"></param>
<param name="arguments"></param>
</member>
<member name="P:Amazon.Runtime.Internal.Util.RequestMetrics.Properties">
<summary>
Collection of properties being tracked
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.RequestMetrics.Timings">
<summary>
Timings for metrics being tracked
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.RequestMetrics.Counters">
<summary>
Counters being tracked
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.RequestMetrics.IsEnabled">
<summary>
Whether metrics are enabled for the request
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.RequestMetrics.#ctor">
<summary>
Constructs an empty, disabled metrics object
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.RequestMetrics.StartEvent(Amazon.Runtime.Metric)">
<summary>
Starts timing an event. Logs an exception if an event
of the same type was started but not stopped.
</summary>
<param name="metric"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.RequestMetrics.StopEvent(Amazon.Runtime.Metric)">
<summary>
Stops timing an event. Logs an exception if the event wasn't started.
</summary>
<param name="metric"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.RequestMetrics.AddProperty(Amazon.Runtime.Metric,System.Object)">
<summary>
Adds a property for a metric. If there are multiple, the
object is added as a new item in a list.
</summary>
<param name="metric"></param>
<param name="property"></param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.RequestMetrics.SetCounter(Amazon.Runtime.Metric,System.Int64)">
<summary>
Sets a counter for a specific metric.
</summary>
<param name="metric"></param>
<param name="value"></param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.RequestMetrics.IncrementCounter(Amazon.Runtime.Metric)">
<summary>
Increments a specific metric counter.
If counter doesn't exist yet, it is set to 1.
</summary>
<param name="metric"></param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.RequestMetrics.GetErrors">
<summary>
Returns errors associated with the metric, including
if there are still any timing events in-flight.
</summary>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.RequestMetrics.ToString">
<summary>
Returns a string representation of the current metrics.
</summary>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.RequestMetrics.ToJSON">
<summary>
Return a JSON represenation of the current metrics
</summary>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.Internal.Util.Timing">
<summary>
Timing information for a metric
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.Timing.#ctor">
<summary>
Empty, stopped timing object
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.Timing.#ctor(System.Int64)">
<summary>
Timing object in a started state
</summary>
<param name="currentTime"></param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.Timing.Stop(System.Int64)">
<summary>
Stops timing
</summary>
<param name="currentTime"></param>
</member>
<member name="P:Amazon.Runtime.Internal.Util.Timing.IsFinished">
<summary>
Whether the timing has been stopped
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.Timing.ElapsedTicks">
<summary>
Elapsed ticks from start to stop.
If timing hasn't been stopped yet, returns 0.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.Timing.ElapsedTime">
<summary>
Elapsed time from start to stop.
If timing hasn't been stopped yet, returns TimeSpan.Zero
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.TimingEvent">
<summary>
Timing event, stops timing of a metric when disposed
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.TimingEvent.Dispose(System.Boolean)">
<summary>
Implements the Dispose pattern
</summary>
<param name="disposing">Whether this object is being disposed via a call to Dispose
or garbage collected.</param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.TimingEvent.Dispose">
<summary>
Disposes of all managed and unmanaged resources.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.TimingEvent.Finalize">
<summary>
The destructor for the client class.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.NonDisposingWrapperStream">
<summary>
A wrapper stream which supresses disposal of the underlying stream.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.NonDisposingWrapperStream.#ctor(System.IO.Stream)">
<summary>
Constructor for NonDisposingWrapperStream.
</summary>
<param name="baseStream">The base stream to wrap.</param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.NonDisposingWrapperStream.Close">
<summary>
The Close implementation for this wrapper stream
does not close the underlying stream.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.NonDisposingWrapperStream.Dispose(System.Boolean)">
<summary>
The Dispose implementation for this wrapper stream
does not close the underlying stream.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.PartialWrapperStream">
<summary>
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.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.ReadOnlyWrapperStream">
<summary>
Wrapper stream that only supports reading
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.PartialReadOnlyWrapperStream">
<summary>
Partial wrapper stream that only supports reading
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.S3Uri">
<summary>
Uri wrapper that can parse out information (bucket, key, region, style) from an
S3 URI.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.S3Uri.IsPathStyle">
<summary>
True if the URI contains the bucket in the path, false if it contains the bucket in the authority.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.S3Uri.Bucket">
<summary>
The bucket name parsed from the URI (or null if no bucket specified).
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.S3Uri.Key">
<summary>
The key parsed from the URI (or null if no key specified).
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.S3Uri.Region">
<summary>
The region parsed from the URI (or null if no region specified).
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.S3Uri.#ctor(System.String)">
<summary>
Constructs a parser for the S3 URI specified as a string.
</summary>
<param name="uri">The S3 URI to be parsed.</param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.S3Uri.#ctor(System.Uri)">
<summary>
Constructs a parser for the S3 URI specified as a Uri instance.
</summary>
<param name="uri">The S3 URI to be parsed.</param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.S3Uri.Decode(System.String)">
<summary>
Percent-decodes the given string, with a fast path for strings that are not
percent-encoded.
</summary>
<param name="s">The string to decode</param>
<returns>The decoded string</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.S3Uri.Decode(System.String,System.Int32)">
<summary>
Percent-decodes the given string.
</summary>
<param name="s">The string to decode</param>
<param name="firstPercent">The index of the first '%' in the string</param>
<returns>The decoded string</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.S3Uri.AppendDecoded(System.Text.StringBuilder,System.String,System.Int32)">
<summary>
Decodes the percent-encoded character at the given index in the string
and appends the decoded value to the string under construction.
</summary>
<param name="builder">
The string under construction to which the decoded character will be
appended.
</param>
<param name="s">The string being decoded.</param>
<param name="index">The index of the '%' character in the string.</param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.S3Uri.FromHex(System.Char)">
<summary>
Converts a hex character (0-9A-Fa-f) into its corresponding quad value.
</summary>
<param name="c">The hex character</param>
<returns>The quad value</returns>
</member>
<member name="T:Amazon.Runtime.Internal.Util.ICache">
<summary>
Interface for a non-generic cache.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.ICache.Clear">
<summary>
Clears the entire cache.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.ICache.MaximumItemLifespan">
<summary>
Maximum time to keep an item around after its last use.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.ICache.CacheClearPeriod">
<summary>
How often should the cache be cleared of old items.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.ICache.ItemCount">
<summary>
The number of items in the cache.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.ICache`2">
<summary>
Interface for a generic cache.
</summary>
<typeparam name="TKey"></typeparam>
<typeparam name="TValue"></typeparam>
</member>
<member name="M:Amazon.Runtime.Internal.Util.ICache`2.GetValue(`0,System.Func{`0,`1})">
<summary>
Retrieves a value out of the cache or from the source.
</summary>
<param name="key"></param>
<param name="creator"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.ICache`2.GetValue(`0,System.Func{`0,`1},System.Boolean@)">
<summary>
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.
</summary>
<param name="key"></param>
<param name="creator"></param>
<param name="isStaleItem"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.ICache`2.Clear(`0)">
<summary>
Clears a specific value from the cache if it's there.
</summary>
<param name="key"></param>
</member>
<member name="P:Amazon.Runtime.Internal.Util.ICache`2.Keys">
<summary>
Returns the keys for all items in the cache.
</summary>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.ICache`2.UseCache``1(`0,System.Func{``0},System.Action,System.Predicate{System.Exception})">
<summary>
Executes specified operation, catches exception, clears the cache for
the given key, retries the operation.
</summary>
<typeparam name="TOut"></typeparam>
<param name="key"></param>
<param name="operation"></param>
<param name="onError"></param>
<param name="shouldRetryForException"></param>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.Internal.Util.SdkCache">
<summary>
SDK-wide cache.
Provides access to caches specific to a particular set of credentials
and target region.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.SdkCache.Clear">
<summary>
Clear all caches
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.SdkCache.Clear(System.Object)">
<summary>
Clear all caches of a particular type
</summary>
<param name="cacheType"></param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.SdkCache.GetCache``2(System.Object,System.Object,System.Collections.Generic.IEqualityComparer{``0})">
<summary>
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.
</summary>
<typeparam name="TKey"></typeparam>
<typeparam name="TValue"></typeparam>
<param name="client"></param>
<param name="cacheIdentifier"></param>
<param name="keyComparer"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.SdkCache.GetCache``2(Amazon.Runtime.AmazonServiceClient,System.Object,System.Collections.Generic.IEqualityComparer{``0})">
<summary>
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.
</summary>
<typeparam name="TKey"></typeparam>
<typeparam name="TValue"></typeparam>
<param name="client"></param>
<param name="cacheIdentifier"></param>
<param name="keyComparer"></param>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.Internal.Util.StringUtils">
<summary>
Utilities for converting objects to strings. Used by the marshaller classes.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.WrapperStream">
<summary>
A wrapper stream.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.WrapperStream.BaseStream">
<summary>
Base stream.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.WrapperStream.#ctor(System.IO.Stream)">
<summary>
Initializes WrapperStream with a base stream.
</summary>
<param name="baseStream"></param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.WrapperStream.GetNonWrapperBaseStream">
<summary>
Returns the first base non-WrapperStream.
</summary>
<returns>First base stream that is non-WrapperStream.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.WrapperStream.GetSeekableBaseStream">
<summary>
Returns the first base non-WrapperStream.
</summary>
<returns>First base stream that is non-WrapperStream.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.WrapperStream.GetNonWrapperBaseStream(System.IO.Stream)">
<summary>
Returns the first base non-WrapperStream.
</summary>
<param name="stream">Potential WrapperStream</param>
<returns>Base non-WrapperStream.</returns>
</member>
<member name="P:Amazon.Runtime.Internal.Util.WrapperStream.CanRead">
<summary>
Gets a value indicating whether the current stream supports reading.
True if the stream supports reading; otherwise, false.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.WrapperStream.CanSeek">
<summary>
Gets a value indicating whether the current stream supports seeking.
True if the stream supports seeking; otherwise, false.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.WrapperStream.CanWrite">
<summary>
Gets a value indicating whether the current stream supports writing.
True if the stream supports writing; otherwise, false.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.WrapperStream.Close">
<summary>
Closes the current stream and releases any resources (such as sockets and
file handles) associated with the current stream.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.WrapperStream.Length">
<summary>
Gets the length in bytes of the stream.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.WrapperStream.Position">
<summary>
Gets or sets the position within the current stream.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.WrapperStream.ReadTimeout">
<summary>
Gets or sets a value, in miliseconds, that determines how long the stream
will attempt to read before timing out.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.WrapperStream.WriteTimeout">
<summary>
Gets or sets a value, in miliseconds, that determines how long the stream
will attempt to write before timing out.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.WrapperStream.Flush">
<summary>
Clears all buffers for this stream and causes any buffered data to be written
to the underlying device.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.WrapperStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Reads a sequence of bytes from the current stream and advances the position
within the stream by the number of bytes read.
</summary>
<param name="buffer">
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.
</param>
<param name="offset">
The zero-based byte offset in buffer at which to begin storing the data read
from the current stream.
</param>
<param name="count">
The maximum number of bytes to be read from the current stream.
</param>
<returns>
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.
</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.WrapperStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Sets the position within the current stream.
</summary>
<param name="offset">A byte offset relative to the origin parameter.</param>
<param name="origin">
A value of type System.IO.SeekOrigin indicating the reference point used
to obtain the new position.</param>
<returns>The new position within the current stream.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.WrapperStream.SetLength(System.Int64)">
<summary>
Sets the length of the current stream.
</summary>
<param name="value">The desired length of the current stream in bytes.</param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.WrapperStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Writes a sequence of bytes to the current stream and advances the current
position within this stream by the number of bytes written.
</summary>
<param name="buffer">
An array of bytes. This method copies count bytes from buffer to the current stream.
</param>
<param name="offset">
The zero-based byte offset in buffer at which to begin copying bytes to the
current stream.
</param>
<param name="count">The number of bytes to be written to the current stream.</param>
</member>
<member name="T:Amazon.Runtime.Internal.Util.DecryptStream">
<summary>
A wrapper stream that decrypts the base stream as it
is being read.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.DecryptStream.#ctor(System.IO.Stream)">
<summary>
Initializes an DecryptStream with an decryption algorithm and a base stream.
</summary>
<param name="baseStream">Stream to perform encryption on..</param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.DecryptStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Reads a sequence of bytes from the current stream and advances the position
within the stream by the number of bytes read.
</summary>
<param name="buffer">
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.
</param>
<param name="offset">
The zero-based byte offset in buffer at which to begin storing the data read
from the current stream.
</param>
<param name="count">
The maximum number of bytes to be read from the current stream.
</param>
<returns>
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.
</returns>
</member>
<member name="P:Amazon.Runtime.Internal.Util.DecryptStream.CanSeek">
<summary>
Gets a value indicating whether the current stream supports seeking.
DecryptStream does not support seeking, this will always be false.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.DecryptStream.Position">
<summary>
Gets or sets the position within the current stream.
DecryptStream does not support seeking, attempting to set Position
will throw NotSupportedException.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.DecryptStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Sets the position within the current stream.
DecryptStream does not support seeking, attempting to call Seek
will throw NotSupportedException.
</summary>
<param name="offset">A byte offset relative to the origin parameter.</param>
<param name="origin">
A value of type System.IO.SeekOrigin indicating the reference point used
to obtain the new position.</param>
<returns>The new position within the current stream.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.DecryptStream.ValidateBaseStream">
<summary>
Validates the underlying stream.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.DecryptStream`1">
<summary>
A wrapper stream that decrypts the base stream as it
is being read.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.DecryptStream`1.#ctor(System.IO.Stream,System.Byte[],System.Byte[])">
<summary>
Initializes an DecryptStream with an decryption algorithm and a base stream.
</summary>
<param name="baseStream">Stream to perform encryption on..</param>
<param name="envelopeKey">Symmetric key to perform decryption</param>
<param name="IV">Initialization vector to perform decryption</param>
</member>
<member name="T:Amazon.Runtime.Internal.Util.AESDecryptionStream">
<summary>
A wrapper stream that decrypts the base stream using AES algorithm as it
is being read.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.AESDecryptionStream.#ctor(System.IO.Stream,System.Byte[],System.Byte[])">
<summary>
Initializes an AESDecryptionStream with a base stream.
</summary>
<param name="baseStream">Stream to perform decryption on..</param>
<param name="key">Symmetric key to perform decryption</param>
<param name="IV">Initialization vector to perform decryption</param>
</member>
<member name="T:Amazon.Runtime.Internal.Util.EncryptStream">
<summary>
A wrapper stream that encrypts the base stream as it
is being read.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.EncryptStream.#ctor(System.IO.Stream)">
<summary>
Initializes an EncryptStream with an encryption algorithm and a base stream.
</summary>
<param name="baseStream">Stream to perform encryption on..</param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.EncryptStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Reads a sequence of bytes from the current stream and advances the position
within the stream by the number of bytes read.
</summary>
<param name="buffer">
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.
</param>
<param name="offset">
The zero-based byte offset in buffer at which to begin storing the data read
from the current stream.
</param>
<param name="count">
The maximum number of bytes to be read from the current stream.
</param>
<returns>
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.
</returns>
</member>
<member name="P:Amazon.Runtime.Internal.Util.EncryptStream.CanSeek">
<summary>
Gets a value indicating whether the current stream supports seeking.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.EncryptStream.Length">
<summary>
Returns encrypted content length.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.EncryptStream.Position">
<summary>
Gets or sets the position within the current stream.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.EncryptStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Sets the position within the current stream.
</summary>
<param name="offset">A byte offset relative to the origin parameter.</param>
<param name="origin">
A value of type System.IO.SeekOrigin indicating the reference point used
to obtain the new position.</param>
<returns>The new position within the current stream.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.EncryptStream.ValidateBaseStream">
<summary>
Validates the underlying stream.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.EncryptStream`1">
<summary>
A wrapper stream that encrypts the base stream as it
is being read.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.EncryptStream`1.#ctor(System.IO.Stream,System.Byte[],System.Byte[])">
<summary>
Initializes an EncryptStream with an encryption algorithm and a base stream.
</summary>
<param name="baseStream">Stream to perform encryption on..</param>
<param name="key">Symmetric key to perform encryption</param>
<param name="IV">Initialization vector to perform encryption</param>
</member>
<member name="T:Amazon.Runtime.Internal.Util.AESEncryptionPutObjectStream">
<summary>
A wrapper stream that encrypts the base stream using AES algorithm as it
is being read.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.AESEncryptionPutObjectStream.#ctor(System.IO.Stream,System.Byte[],System.Byte[])">
<summary>
Initializes an AESEncryptionStream with a base stream.
</summary>
<param name="baseStream">Stream to perform encryption on..</param>
<param name="key">Symmetric key to perform encryption</param>
<param name="IV">Initialization vector to perform encryption</param>
</member>
<member name="T:Amazon.Runtime.Internal.Util.EncryptUploadPartStream">
<summary>
A wrapper stream that encrypts the base stream as it
is being read.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.EncryptUploadPartStream.#ctor(System.IO.Stream)">
<summary>
Initializes an EncryptStream for Multipart uploads with an encryption algorithm and a base stream.
</summary>
<param name="baseStream">Stream to perform encryption on..</param>
</member>
<member name="M:Amazon.Runtime.Internal.Util.EncryptUploadPartStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Reads a sequence of bytes from the current stream and advances the position
within the stream by the number of bytes read.
</summary>
<param name="buffer">
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.
</param>
<param name="offset">
The zero-based byte offset in buffer at which to begin storing the data read
from the current stream.
</param>
<param name="count">
The maximum number of bytes to be read from the current stream.
</param>
<returns>
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.
</returns>
</member>
<member name="P:Amazon.Runtime.Internal.Util.EncryptUploadPartStream.CanSeek">
<summary>
Gets a value indicating whether the current stream supports seeking.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.EncryptUploadPartStream.Length">
<summary>
Returns encrypted content length.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.Util.EncryptUploadPartStream.Position">
<summary>
Gets or sets the position within the current stream.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.EncryptUploadPartStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Sets the position within the current stream.
</summary>
<param name="offset">A byte offset relative to the origin parameter.</param>
<param name="origin">
A value of type System.IO.SeekOrigin indicating the reference point used
to obtain the new position.</param>
<returns>The new position within the current stream.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.EncryptUploadPartStream.ValidateBaseStream">
<summary>
Validates the underlying stream.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.EncryptUploadPartStream`1">
<summary>
A wrapper stream that encrypts the base stream as it
is being read.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.EncryptUploadPartStream`1.#ctor(System.IO.Stream,System.Byte[],System.Byte[])">
<summary>
Initializes an EncryptStream with an encryption algorithm and a base stream.
</summary>
<param name="baseStream">Stream to perform encryption on..</param>
<param name="key">Symmetric key to perform encryption</param>
<param name="IV">Initialization vector to perform encryption</param>
</member>
<member name="T:Amazon.Runtime.Internal.Util.AESEncryptionUploadPartStream">
<summary>
A wrapper stream that encrypts the base stream as it
is being read.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.AESEncryptionUploadPartStream.#ctor(System.IO.Stream,System.Byte[],System.Byte[])">
<summary>
Initializes an AESEncryptionStream with a base stream.
</summary>
<param name="baseStream">Stream to perform encryption on..</param>
<param name="key">Symmetric key to perform encryption</param>
<param name="IV">Initialization vector to perform encryption</param>
</member>
<member name="T:Amazon.Runtime.Internal.Util.InternalSystemDiagnosticsLogger">
<summary>
Logger wrapper for System.Diagnostics.TraceSource logger.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.Util.TraceSourceUtil">
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Util.TraceSourceUtil.GetTraceSource(System.Type)">
<summary>
Gets a TraceSource for given Type with SourceLevels.All.
If there are no listeners configured for targetType or one of its "parents", returns null.
</summary>
<param name="targetType"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.Util.TraceSourceUtil.GetTraceSource(System.Type,System.Diagnostics.SourceLevels)">
<summary>
Gets a TraceSource for given Type and SourceLevels.
If there are no listeners configured for targetType or one of its "parents", returns null.
</summary>
<param name="targetType"></param>
<param name="sourceLevels"></param>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.Internal.PipelineHandler">
<summary>
An abstract pipeline handler that has implements IPipelineHandler,
and has the default implmentation. This is the base class for most of
the handler implementations.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.PipelineHandler.Logger">
<summary>
The logger used to log messages.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.PipelineHandler.InnerHandler">
<summary>
The inner handler which is called after the current
handler completes it's processing.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.PipelineHandler.OuterHandler">
<summary>
The outer handler which encapsulates the current handler.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.PipelineHandler.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
Contains the processing logic for a synchronous request invocation.
This method calls InnerHandler.InvokeSync to continue processing of the
request by the pipeline.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.PipelineHandler.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
Contains the processing logic for an asynchronous request invocation.
This method calls InnerHandler.InvokeSync to continue processing of the
request by the pipeline.
</summary>
<typeparam name="T">The response type for the current request.</typeparam>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.PipelineHandler.LogMetrics(Amazon.Runtime.IExecutionContext)">
<summary>
Logs the metrics for the current execution context.
</summary>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimeAsyncResult.Dispose(System.Boolean)">
<summary>
Implements the Dispose pattern
</summary>
<param name="disposing">Whether this object is being disposed via a call to Dispose
or garbage collected.</param>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimeAsyncResult.Dispose">
<summary>
Disposes of all managed and unmanaged resources.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.RuntimePipeline">
<summary>
A runtime pipeline contains a collection of handlers which represent
different stages of request and response processing.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.RuntimePipeline.Handler">
<summary>
The top-most handler in the pipeline.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimePipeline.#ctor(Amazon.Runtime.IPipelineHandler)">
<summary>
Constructor for RuntimePipeline.
</summary>
<param name="handler">The handler with which the pipeline is initalized.</param>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimePipeline.#ctor(System.Collections.Generic.IList{Amazon.Runtime.IPipelineHandler})">
<summary>
Constructor for RuntimePipeline.
</summary>
<param name="handlers">List of handlers with which the pipeline is initalized.</param>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimePipeline.#ctor(System.Collections.Generic.IList{Amazon.Runtime.IPipelineHandler},Amazon.Runtime.Internal.Util.ILogger)">
<summary>
Constructor for RuntimePipeline.
</summary>
<param name="handlers">List of handlers with which the pipeline is initalized.</param>
<param name="logger">The logger used to log messages.</param>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimePipeline.#ctor(Amazon.Runtime.IPipelineHandler,Amazon.Runtime.Internal.Util.ILogger)">
<summary>
Constructor for RuntimePipeline.
</summary>
<param name="handler">The handler with which the pipeline is initalized.</param>
<param name="logger">The logger used to log messages.</param>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimePipeline.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
Invokes the pipeline synchronously.
</summary>
<param name="executionContext">Request context</param>
<returns>Response context</returns>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimePipeline.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
Invokes the pipeline asynchronously.
</summary>
<param name="executionContext">Request context</param>
<returns>Response context</returns>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimePipeline.AddHandler(Amazon.Runtime.IPipelineHandler)">
<summary>
Adds a new handler to the top of the pipeline.
</summary>
<param name="handler">The handler to be added to the pipeline.</param>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimePipeline.AddHandlerAfter``1(Amazon.Runtime.IPipelineHandler)">
<summary>
Adds a handler after the first instance of handler of type T.
</summary>
<typeparam name="T">Type of the handler after which the given handler instance is added.</typeparam>
<param name="handler">The handler to be added to the pipeline.</param>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimePipeline.AddHandlerBefore``1(Amazon.Runtime.IPipelineHandler)">
<summary>
Adds a handler before the first instance of handler of type T.
</summary>
<typeparam name="T">Type of the handler before which the given handler instance is added.</typeparam>
<param name="handler">The handler to be added to the pipeline.</param>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimePipeline.RemoveHandler``1">
<summary>
Removes the first occurance of a handler of type T.
</summary>
<typeparam name="T">Type of the handler which will be removed.</typeparam>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimePipeline.ReplaceHandler``1(Amazon.Runtime.IPipelineHandler)">
<summary>
Replaces the first occurance of a handler of type T with the given handler.
</summary>
<typeparam name="T">Type of the handler which will be replaced.</typeparam>
<param name="handler">The handler to be added to the pipeline.</param>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimePipeline.InsertHandler(Amazon.Runtime.IPipelineHandler,Amazon.Runtime.IPipelineHandler)">
<summary>
Inserts the given handler after current handler in the pipeline.
</summary>
<param name="handler">Handler to be inserted in the pipeline.</param>
<param name="current">Handler after which the given handler is inserted.</param>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimePipeline.GetInnermostHandler(Amazon.Runtime.IPipelineHandler)">
<summary>
Gets the innermost handler by traversing the inner handler till
it reaches the last one.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.RuntimePipeline.Handlers">
<summary>
Retrieves a list of handlers, in the order of their execution.
</summary>
<returns>Handlers in the current pipeline.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.RuntimePipeline.EnumerateHandlers">
<summary>
Retrieves current handlers, in the order of their execution.
</summary>
<returns>Handlers in the current pipeline.</returns>
</member>
<member name="T:Amazon.Runtime.Internal.ErrorHandler">
<summary>
This handler processes exceptions thrown from the HTTP handler and
unmarshalls error responses.
</summary>
</member>
<member name="F:Amazon.Runtime.Internal.ErrorHandler._exceptionHandlers">
<summary>
Default set of exception handlers.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.ErrorHandler.ExceptionHandlers">
<summary>
Default set of exception handlers.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.ErrorHandler.#ctor(Amazon.Runtime.Internal.Util.ILogger)">
<summary>
Constructor for ErrorHandler.
</summary>
<param name="logger">an ILogger instance.</param>
</member>
<member name="M:Amazon.Runtime.Internal.ErrorHandler.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
Handles and processes any exception thrown from underlying handlers.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.ErrorHandler.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
Handles and processes any exception thrown from underlying handlers.
</summary>
<typeparam name="T">The response type for the current request.</typeparam>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.ErrorHandler.DisposeReponse(Amazon.Runtime.IResponseContext)">
<summary>
Disposes the response body.
</summary>
<param name="responseContext">The response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.ErrorHandler.ProcessException(Amazon.Runtime.IExecutionContext,System.Exception)">
<summary>
Processes an exception by invoking a matching exception handler
for the given exception.
</summary>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<param name="exception">The exception to be processed.</param>
<returns>
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.
</returns>
</member>
<member name="T:Amazon.Runtime.Internal.ExceptionHandler`1">
<summary>
The abstract base class for exception handlers.
</summary>
<typeparam name="T">The exception type.</typeparam>
</member>
<member name="T:Amazon.Runtime.Internal.HttpErrorResponseExceptionHandler">
<summary>
The exception handler for HttpErrorResponseException exception.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.HttpErrorResponseExceptionHandler.#ctor(Amazon.Runtime.Internal.Util.ILogger)">
<summary>
The constructor for HttpErrorResponseExceptionHandler.
</summary>
<param name="logger">in instance of ILogger.</param>
</member>
<member name="M:Amazon.Runtime.Internal.HttpErrorResponseExceptionHandler.HandleException(Amazon.Runtime.IExecutionContext,Amazon.Runtime.Internal.HttpErrorResponseException)">
<summary>
Handles an exception for the given execution context.
</summary>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<param name="exception">The exception to handle.</param>
<returns>
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.
</returns>
</member>
<member name="M:Amazon.Runtime.Internal.HttpErrorResponseExceptionHandler.HandleSuppressed404(Amazon.Runtime.IExecutionContext,Amazon.Runtime.Internal.Transform.IWebResponseData)">
<summary>
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.
</summary>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<param name="httpErrorResponse"></param>
<returns>
If a suppressed 404 is present, returns true, else returns false.
</returns>
</member>
<member name="T:Amazon.Runtime.Internal.WebExceptionHandler">
<summary>
The exception handler for HttpErrorResponseException exception.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.CallbackHandler">
<summary>
A pipeline handler which provides hooks to run
external code in the pre-invoke and post-invoke phases.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.CallbackHandler.OnPreInvoke">
<summary>
Action to execute on the pre invoke phase.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.CallbackHandler.OnPostInvoke">
<summary>
Action to execute on the post invoke phase.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.CallbackHandler.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
Calls the PreInvoke and PostInvoke methods before and after calling the next handler
in the pipeline.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.CallbackHandler.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
Calls the PreInvoke and PostInvoke methods before and after calling the next handler
in the pipeline.
</summary>
<typeparam name="T">The response type for the current request.</typeparam>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.CallbackHandler.PreInvoke(Amazon.Runtime.IExecutionContext)">
<summary>
Executes the OnPreInvoke action as part of pre-invoke.
</summary>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.CallbackHandler.PostInvoke(Amazon.Runtime.IExecutionContext)">
<summary>
Executes the OnPreInvoke action as part of post-invoke.
</summary>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
</member>
<member name="T:Amazon.Runtime.Internal.CredentialsRetriever">
<summary>
This handler retrieved the AWS credentials to be used for the current call.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.CredentialsRetriever.#ctor(Amazon.Runtime.AWSCredentials)">
<summary>
The constructor for CredentialsRetriever.
</summary>
<param name="credentials">An AWSCredentials instance.</param>
</member>
<member name="M:Amazon.Runtime.Internal.CredentialsRetriever.PreInvoke(Amazon.Runtime.IExecutionContext)">
<summary>
Retrieves the credentials to be used for the current call before
invoking the next handler.
</summary>
<param name="executionContext"></param>
</member>
<member name="M:Amazon.Runtime.Internal.CredentialsRetriever.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
Calls pre invoke logic before calling the next handler
in the pipeline.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.CredentialsRetriever.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
Calls pre invoke logic before calling the next handler
in the pipeline.
</summary>
<typeparam name="T">The response type for the current request.</typeparam>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="T:Amazon.Runtime.Internal.EndpointResolver">
<summary>
This handler resolves the endpoint to be used for the current request.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.EndpointResolver.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
Calls pre invoke logic before calling the next handler
in the pipeline.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.EndpointResolver.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
Calls pre invoke logic before calling the next handler
in the pipeline.
</summary>
<typeparam name="T">The response type for the current request.</typeparam>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.EndpointResolver.PreInvoke(Amazon.Runtime.IExecutionContext)">
<summary>
Resolves the endpoint to be used for the current request
before invoking the next handler.
</summary>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.EndpointResolver.DetermineEndpoint(Amazon.Runtime.IRequestContext)">
<summary>
Determines the endpoint for the request.
</summary>
<param name="requestContext">The request context.</param>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.Internal.ErrorCallbackHandler">
<summary>
This handler provides an OnError action that can be used as hook for
external code to handle exceptions in the runtime pipeline.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.ErrorCallbackHandler.OnError">
<summary>
Action to execute if an exception occurs during the
execution of any underlying handlers.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.ErrorCallbackHandler.HandleException(Amazon.Runtime.IExecutionContext,System.Exception)">
<summary>
Executes the OnError action if an exception occurs during the
execution of any underlying handlers.
</summary>
<param name="executionContext"></param>
<param name="exception"></param>
</member>
<member name="T:Amazon.Runtime.Internal.Marshaller">
<summary>
This handler marshalls the request before calling invoking the next handler.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Marshaller.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
Calls pre invoke logic before calling the next handler
in the pipeline.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.Marshaller.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
Calls pre invoke logic before calling the next handler
in the pipeline.
</summary>
<typeparam name="T">The response type for the current request.</typeparam>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Marshaller.PreInvoke(Amazon.Runtime.IExecutionContext)">
<summary>
Marshalls the request before calling invoking the next handler.
</summary>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
</member>
<member name="T:Amazon.Runtime.Internal.MetricsHandler">
<summary>
This handler manages the metrics used to time the complete call and
logs the final metrics.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.MetricsHandler.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
Captures the overall execution time and logs final metrics.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.MetricsHandler.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
Captures the overall execution time and logs final metrics.
</summary>
<typeparam name="T">The response type for the current request.</typeparam>
<param name="executionContext">
The execution context, it contains the request and response context.
</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="T:Amazon.Runtime.Internal.RedirectHandler">
<summary>
This handler processes HTTP redirects and reissues the call to the
redirected location.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.RedirectHandler.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
Processes HTTP redirects and reissues the call to the
redirected location.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.RedirectHandler.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
Processes HTTP redirects and reissues the call to the
redirected location.
</summary>
<typeparam name="T">The response type for the current request.</typeparam>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.RedirectHandler.HandleRedirect(Amazon.Runtime.IExecutionContext)">
<summary>
Checks if an HTTP 307 (temporary redirect) has occured and changes the
request endpoint to the redirected location.
</summary>
<param name="executionContext">
The execution context, it contains the request and response context.
</param>
<returns>
A boolean value that indicates if a redirect has occured.
</returns>
</member>
<member name="T:Amazon.Runtime.Internal.Signer">
<summary>
This handler signs the request.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Signer.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
Calls pre invoke logic before calling the next handler
in the pipeline.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.Signer.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
Calls pre invoke logic before calling the next handler
in the pipeline.
</summary>
<typeparam name="T">The response type for the current request.</typeparam>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Signer.PreInvoke(Amazon.Runtime.IExecutionContext)">
<summary>
Signs the request before invoking the next handler.
</summary>
<param name="executionContext">
The execution context, it contains the request and response context.
</param>
</member>
<member name="M:Amazon.Runtime.Internal.Signer.ShouldSign(Amazon.Runtime.IRequestContext)">
<summary>
Determines if the request should be signed.
</summary>
<param name="requestContext">The request context.</param>
<returns>A boolean value that indicated if the request should be signed.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Signer.SignRequest(Amazon.Runtime.IRequestContext)">
<summary>
Signs the request.
</summary>
<param name="requestContext">The request context.</param>
</member>
<member name="T:Amazon.Runtime.Internal.Unmarshaller">
<summary>
This handler unmarshalls the HTTP response.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.Unmarshaller.#ctor(System.Boolean)">
<summary>
The constructor for Unmarshaller.
</summary>
<param name="supportsResponseLogging">
Boolean value which indicated if the unmarshaller
handler supports response logging.
</param>
</member>
<member name="M:Amazon.Runtime.Internal.Unmarshaller.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
Unmarshalls the response returned by the HttpHandler.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.Unmarshaller.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
Unmarshalls the response returned by the HttpHandler.
</summary>
<typeparam name="T">The response type for the current request.</typeparam>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.Unmarshaller.Unmarshall(Amazon.Runtime.IExecutionContext)">
<summary>
Unmarshalls the HTTP response.
</summary>
<param name="executionContext">
The execution context, it contains the request and response context.
</param>
</member>
<member name="T:Amazon.Runtime.Internal.HttpHandler`1">
<summary>
The HTTP handler contains common logic for issuing an HTTP request that is
independent of the underlying HTTP infrastructure.
</summary>
<typeparam name="TRequestContent"></typeparam>
</member>
<member name="P:Amazon.Runtime.Internal.HttpHandler`1.CallbackSender">
<summary>
The sender parameter used in any events raised by this handler.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.HttpHandler`1.#ctor(Amazon.Runtime.IHttpRequestFactory{`0},System.Object)">
<summary>
The constructor for HttpHandler.
</summary>
<param name="requestFactory">The request factory used to create HTTP Requests.</param>
<param name="callbackSender">The sender parameter used in any events raised by this handler.</param>
</member>
<member name="M:Amazon.Runtime.Internal.HttpHandler`1.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
Issues an HTTP request for the current request context.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.HttpHandler`1.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
Issues an HTTP request for the current request context.
</summary>
<typeparam name="T">The response type for the current request.</typeparam>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.HttpHandler`1.WriteContentToRequestBody(`0,Amazon.Runtime.IHttpRequest{`0},Amazon.Runtime.IRequestContext)">
<summary>
Determines the content for request body and uses the HTTP request
to write the content to the HTTP request body.
</summary>
<param name="requestContent">Content to be written.</param>
<param name="httpRequest">The HTTP request.</param>
<param name="requestContext">The request context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.HttpHandler`1.CreateWebRequest(Amazon.Runtime.IRequestContext)">
<summary>
Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings.
</summary>
<param name="requestContext">The async request.</param>
<returns>The web request that actually makes the call.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.HttpHandler`1.Dispose">
<summary>
Disposes the HTTP handler.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.HttpWebRequestFactory">
<summary>
The request factory for System.Net.HttpWebRequest.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.HttpWebRequestFactory.CreateHttpRequest(System.Uri)">
<summary>
Creates an HTTP request for the given URI.
</summary>
<param name="requestUri">The request URI.</param>
<returns>An HTTP request.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.HttpWebRequestFactory.Dispose">
<summary>
Disposes the HttpWebRequestFactory.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.HttpRequest">
<summary>
HTTP request wrapper for System.Net.HttpWebRequest.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.HttpRequest.#ctor(System.Uri)">
<summary>
Constructor for HttpRequest.
</summary>
<param name="requestUri">The request URI.</param>
</member>
<member name="P:Amazon.Runtime.Internal.HttpRequest.Request">
<summary>
The underlying HTTP web request.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.HttpRequest.Method">
<summary>
The HTTP method or verb.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.HttpRequest.RequestUri">
<summary>
The request URI.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.HttpRequest.GetResponse">
<summary>
Returns the HTTP response.
</summary>
<returns>The HTTP response.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.HttpRequest.GetRequestContent">
<summary>
Gets a handle to the request content.
</summary>
<returns>The request content.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.HttpRequest.WriteToRequestBody(System.IO.Stream,System.IO.Stream,System.Collections.Generic.IDictionary{System.String,System.String},Amazon.Runtime.IRequestContext)">
<summary>
Writes a stream to the request body.
</summary>
<param name="requestContent">The destination where the content stream is written.</param>
<param name="contentStream">The content stream to be written.</param>
<param name="contentHeaders">HTTP content headers.</param>
<param name="requestContext">The request context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.HttpRequest.WriteToRequestBody(System.IO.Stream,System.Byte[],System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Writes a byte array to the request body.
</summary>
<param name="requestContent">The destination where the content stream is written.</param>
<param name="content">The content stream to be written.</param>
<param name="contentHeaders">HTTP content headers.</param>
</member>
<member name="M:Amazon.Runtime.Internal.HttpRequest.Abort">
<summary>
Aborts the HTTP request.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.HttpRequest.GetRequestContentAsync">
<summary>
Gets a handle to the request content.
</summary>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.HttpRequest.GetResponseAsync(System.Threading.CancellationToken)">
<summary>
Returns the HTTP response.
</summary>
<param name="cancellationToken">A cancellation token that can be used to cancel the asynchronous operation.</param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.Internal.HttpRequest.ConfigureRequest(Amazon.Runtime.IRequestContext)">
<summary>
Configures a request as per the request context.
</summary>
<param name="requestContext">The request context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.HttpRequest.SetRequestHeaders(System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Sets the headers on the request.
</summary>
<param name="headers">A dictionary of header names and values.</param>
</member>
<member name="M:Amazon.Runtime.Internal.HttpRequest.Dispose">
<summary>
Disposes the HttpRequest.
</summary>
</member>
<member name="T:Amazon.Runtime.Internal.DefaultRetryPolicy">
<summary>
The default implementation of the retry policy.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRetryPolicy.MaxBackoffInMilliseconds">
<summary>
The maximum value of exponential backoff in milliseconds, which will be used to wait
before retrying a request.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRetryPolicy.ErrorCodesToRetryOn">
<summary>
List of AWS specific error codes which are returned as part of the error response.
These error codes will be retried.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.DefaultRetryPolicy.WebExceptionStatusesToRetryOn">
<summary>
List of WebExceptionStatus for a WebException which will be retried.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.DefaultRetryPolicy.#ctor(System.Int32)">
<summary>
Constructor for DefaultRetryPolicy.
</summary>
<param name="maxRetries">The maximum number of retries before throwing
back a exception. This does not count the initial request.</param>
</member>
<member name="M:Amazon.Runtime.Internal.DefaultRetryPolicy.CanRetry(Amazon.Runtime.IExecutionContext)">
<summary>
Returns true if the request is in a state where it can be retried, else false.
</summary>
<param name="executionContext">Request context containing the state of the request.</param>
<returns>Returns true if the request is in a state where it can be retried, else false.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.DefaultRetryPolicy.RetryForException(Amazon.Runtime.IExecutionContext,System.Exception)">
<summary>
Return true if the request should be retried.
</summary>
<param name="executionContext">Request context containing the state of the request.</param>
<param name="exception">The exception thrown by the previous request.</param>
<returns>Return true if the request should be retried.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.DefaultRetryPolicy.RetryLimitReached(Amazon.Runtime.IExecutionContext)">
<summary>
Checks if the retry limit is reached.
</summary>
<param name="executionContext">Request context containing the state of the request.</param>
<returns>Return false if the request can be retried, based on number of retries.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.DefaultRetryPolicy.WaitBeforeRetry(Amazon.Runtime.IExecutionContext)">
<summary>
Waits before retrying a request. The default policy implements a exponential backoff.
</summary>
<param name="executionContext">Request context containing the state of the request.</param>
</member>
<member name="T:Amazon.Runtime.Internal.RetryHandler">
<summary>
The retry handler has the generic logic for retrying requests.
It uses a retry policy which specifies when
a retry should be performed.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.RetryHandler.Logger">
<summary>
The logger used to log messages.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.RetryHandler.RetryPolicy">
<summary>
The retry policy which specifies when
a retry should be performed.
</summary>
</member>
<member name="M:Amazon.Runtime.Internal.RetryHandler.#ctor(Amazon.Runtime.RetryPolicy)">
<summary>
Constructor which takes in a retry policy.
</summary>
<param name="retryPolicy">Retry Policy</param>
</member>
<member name="M:Amazon.Runtime.Internal.RetryHandler.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
Invokes the inner handler and performs a retry, if required as per the
retry policy.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="M:Amazon.Runtime.Internal.RetryHandler.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
Invokes the inner handler and performs a retry, if required as per the
retry policy.
</summary>
<typeparam name="T">The response type for the current request.</typeparam>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:Amazon.Runtime.Internal.RetryHandler.PrepareForRetry(Amazon.Runtime.IRequestContext)">
<summary>
Prepares the request for retry.
</summary>
<param name="requestContext">Request context containing the state of the request.</param>
</member>
<member name="T:Amazon.Runtime.Internal.ClientContextConfig">
<summary>
Provides information for Client Context header.
Client Context header needs information like App title, version code, version name, package name etc.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.ClientContextConfig.AppTitle">
<summary>
The title of your app. For example, "My App".
If this property is not null, the value would be used in Client Context header.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.ClientContextConfig.AppVersionName">
<summary>
The version for your app. For example, V3.0.
If this property is not null, the value would be used in Client Context header.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.ClientContextConfig.AppVersionCode">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.ClientContextConfig.AppPackageName">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.ClientContextConfig.Platform">
<summary>
The operating system of the device. For example, iPhoneOS.
If this property is not null, the value would be used in Client Context header.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.ClientContextConfig.PlatformVersion">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.ClientContextConfig.Locale">
<summary>
The locale of the device. For example, en_US.
If this property is not null, the value would be used in Client Context header.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.ClientContextConfig.Make">
<summary>
The manufacturer of the device. For example, Samsung.
If this property is not null, the value would be used in Client Context header.
</summary>
</member>
<member name="P:Amazon.Runtime.Internal.ClientContextConfig.Model">
<summary>
The model of the device. For example, Nexus.
If this property is not null, the value would be used in Client Context header.
</summary>
</member>
<member name="T:Amazon.Runtime.ConstantClass">
<summary>
Base class for constant class that holds the value that will be sent to AWS for the static constants.
</summary>
</member>
<member name="P:Amazon.Runtime.ConstantClass.Value">
<summary>
Gets the value that needs to be used when send the value to AWS
</summary>
</member>
<member name="M:Amazon.Runtime.ConstantClass.Intern">
<summary>
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.
</summary>
<returns>The properly cased service constant matching the value</returns>
</member>
<member name="T:Amazon.Runtime.SigningAlgorithm">
<summary>
The valid hashing algorithm supported by the sdk for request signing.
</summary>
</member>
<member name="T:Amazon.Runtime.ErrorType">
<summary>
Which end of a request was responsible for a service error response.
</summary>
</member>
<member name="F:Amazon.Runtime.ErrorType.Sender">
<summary>
The sender was responsible for the error, i.e. the client
request failed validation or was improperly formatted.
</summary>
</member>
<member name="F:Amazon.Runtime.ErrorType.Receiver">
<summary>
The error occured within the service.
</summary>
</member>
<member name="F:Amazon.Runtime.ErrorType.Unknown">
<summary>
An unrecognized error type was returned.
</summary>
</member>
<member name="T:Amazon.Runtime.IRequestMetrics">
<summary>
Metrics collected by the SDK on a per-request basis.
</summary>
<remarks>
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.
</remarks>
</member>
<member name="P:Amazon.Runtime.IRequestMetrics.Properties">
<summary>
Collection of properties being tracked
</summary>
</member>
<member name="P:Amazon.Runtime.IRequestMetrics.Timings">
<summary>
Timings for metrics being tracked
</summary>
</member>
<member name="P:Amazon.Runtime.IRequestMetrics.Counters">
<summary>
Counters being tracked
</summary>
</member>
<member name="P:Amazon.Runtime.IRequestMetrics.IsEnabled">
<summary>
Whether metrics are enabled for the request
</summary>
</member>
<member name="M:Amazon.Runtime.IRequestMetrics.ToJSON">
<summary>
JSON representation of the current metrics
</summary>
<returns>JSON string</returns>
</member>
<member name="T:Amazon.Runtime.IMetricsTiming">
<summary>
Represents how long a phase of an SDK request took.
</summary>
</member>
<member name="P:Amazon.Runtime.IMetricsTiming.IsFinished">
<summary>
Whether the timing has been stopped
</summary>
</member>
<member name="P:Amazon.Runtime.IMetricsTiming.ElapsedTicks">
<summary>
Elapsed ticks from start to stop.
If timing hasn't been stopped yet, returns 0.
</summary>
</member>
<member name="P:Amazon.Runtime.IMetricsTiming.ElapsedTime">
<summary>
Elapsed time from start to stop.
If timing hasn't been stopped yet, returns TimeSpan.Zero
</summary>
</member>
<member name="T:Amazon.Runtime.IMetricsFormatter">
<summary>
User supplied type to perform metrics formatting.
</summary>
</member>
<member name="M:Amazon.Runtime.IMetricsFormatter.FormatMetrics(Amazon.Runtime.IRequestMetrics)">
<summary>
Produce custom formatting for SDK metrics.
</summary>
<remarks>
If defined, this method will be called for every request made by the SDK.
</remarks>
<param name="metrics">An instance of IRequestMetrics produced by the SDK</param>
<returns>formatted string representation of the metrics</returns>
</member>
<member name="T:Amazon.Runtime.Metric">
<summary>
Predefined request metrics that are collected by the SDK.
</summary>
</member>
<member name="T:Amazon.Runtime.ResponseMetadata">
<summary>
Information about the request.
</summary>
</member>
<member name="P:Amazon.Runtime.ResponseMetadata.RequestId">
<summary>
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.
</summary>
</member>
<member name="T:Amazon.Runtime.SignatureException">
<summary>
This exception is thrown if there are problems signing the request.
</summary>
</member>
<member name="M:Amazon.Runtime.StreamTransferProgressArgs.#ctor(System.Int64,System.Int64,System.Int64)">
<summary>
The constructor takes the number of
currently transferred bytes and the
total number of bytes to be transferred
</summary>
<param name="incrementTransferred">The number of bytes transferred since last event</param>
<param name="transferred">The number of bytes transferred</param>
<param name="total">The total number of bytes to be transferred</param>
</member>
<member name="P:Amazon.Runtime.StreamTransferProgressArgs.PercentDone">
<summary>
Gets the percentage of transfer completed
</summary>
</member>
<member name="P:Amazon.Runtime.StreamTransferProgressArgs.IncrementTransferred">
<summary>
Gets the number of bytes transferred since last event
</summary>
</member>
<member name="P:Amazon.Runtime.StreamTransferProgressArgs.TransferredBytes">
<summary>
Gets the number of bytes transferred
</summary>
</member>
<member name="P:Amazon.Runtime.StreamTransferProgressArgs.TotalBytes">
<summary>
Gets the total number of bytes to be transferred
</summary>
</member>
<member name="M:Amazon.Runtime.StreamTransferProgressArgs.ToString">
<summary>
Returns a string representation of this object
</summary>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.IPipelineHandler">
<summary>
Interface for a handler in a pipeline.
</summary>
</member>
<member name="P:Amazon.Runtime.IPipelineHandler.Logger">
<summary>
The logger used to log messages.
</summary>
</member>
<member name="P:Amazon.Runtime.IPipelineHandler.InnerHandler">
<summary>
The inner handler which is called after the current
handler completes it's processing.
</summary>
</member>
<member name="P:Amazon.Runtime.IPipelineHandler.OuterHandler">
<summary>
The outer handler which encapsulates the current handler.
</summary>
</member>
<member name="M:Amazon.Runtime.IPipelineHandler.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
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.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="M:Amazon.Runtime.IPipelineHandler.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
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.
</summary>
<typeparam name="T">The response type for the current request.</typeparam>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="T:Amazon.Runtime.IExceptionHandler">
<summary>
The interface for an exception handler.
</summary>
</member>
<member name="M:Amazon.Runtime.IExceptionHandler.Handle(Amazon.Runtime.IExecutionContext,System.Exception)">
<summary>
Handles an exception for the given execution context.
</summary>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<param name="exception">The exception to handle.</param>
<returns>
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.
</returns>
</member>
<member name="T:Amazon.Runtime.IExceptionHandler`1">
<summary>
The interface for an exception handler with a generic parameter for the exception type.
</summary>
<typeparam name="T">The exception type.</typeparam>
</member>
<member name="M:Amazon.Runtime.IExceptionHandler`1.HandleException(Amazon.Runtime.IExecutionContext,`0)">
<summary>
Handles an exception for the given execution context.
</summary>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<param name="exception">The exception to handle.</param>
<returns>
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.
</returns>
</member>
<member name="T:Amazon.Runtime.IHttpRequestFactory`1">
<summary>
The interface for a HTTP request factory.
</summary>
<typeparam name="TRequestContent">The type used by the underlying HTTP API to represent the request body.</typeparam>
</member>
<member name="M:Amazon.Runtime.IHttpRequestFactory`1.CreateHttpRequest(System.Uri)">
<summary>
Creates an HTTP request for the given URI.
</summary>
<param name="requestUri">The request URI.</param>
<returns>An HTTP request.</returns>
</member>
<member name="T:Amazon.Runtime.IHttpRequest`1">
<summary>
The interface for an HTTP request that is agnostic of the underlying HTTP API.
</summary>
<typeparam name="TRequestContent">The type used by the underlying HTTP API to represent the HTTP request content.</typeparam>
</member>
<member name="P:Amazon.Runtime.IHttpRequest`1.Method">
<summary>
The HTTP method or verb.
</summary>
</member>
<member name="P:Amazon.Runtime.IHttpRequest`1.RequestUri">
<summary>
The request URI.
</summary>
</member>
<member name="M:Amazon.Runtime.IHttpRequest`1.ConfigureRequest(Amazon.Runtime.IRequestContext)">
<summary>
Configures a request as per the request context.
</summary>
<param name="requestContext">The request context.</param>
</member>
<member name="M:Amazon.Runtime.IHttpRequest`1.SetRequestHeaders(System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Sets the headers on the request.
</summary>
<param name="headers">A dictionary of header names and values.</param>
</member>
<member name="M:Amazon.Runtime.IHttpRequest`1.GetRequestContent">
<summary>
Gets a handle to the request content.
</summary>
<returns>The request content.</returns>
</member>
<member name="M:Amazon.Runtime.IHttpRequest`1.GetResponse">
<summary>
Returns the HTTP response.
</summary>
<returns>The HTTP response.</returns>
</member>
<member name="M:Amazon.Runtime.IHttpRequest`1.WriteToRequestBody(`0,System.IO.Stream,System.Collections.Generic.IDictionary{System.String,System.String},Amazon.Runtime.IRequestContext)">
<summary>
Writes a stream to the request body.
</summary>
<param name="requestContent">The destination where the content stream is written.</param>
<param name="contentStream">The content stream to be written.</param>
<param name="contentHeaders">HTTP content headers.</param>
<param name="requestContext">The request context.</param>
</member>
<member name="M:Amazon.Runtime.IHttpRequest`1.WriteToRequestBody(`0,System.Byte[],System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Writes a byte array to the request body.
</summary>
<param name="requestContent">The destination where the content stream is written.</param>
<param name="content">The content stream to be written.</param>
<param name="contentHeaders">HTTP content headers.</param>
</member>
<member name="M:Amazon.Runtime.IHttpRequest`1.Abort">
<summary>
Aborts the HTTP request.
</summary>
</member>
<member name="M:Amazon.Runtime.IHttpRequest`1.GetRequestContentAsync">
<summary>
Gets a handle to the request content.
</summary>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.IHttpRequest`1.GetResponseAsync(System.Threading.CancellationToken)">
<summary>
Returns the HTTP response.
</summary>
<param name="cancellationToken">A cancellation token that can be used to cancel the asynchronous operation.</param>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.RetryPolicy">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Runtime.RetryPolicy.MaxRetries">
<summary>
Maximum number of retries to be performed.
This does not count the initial request.
</summary>
</member>
<member name="P:Amazon.Runtime.RetryPolicy.Logger">
<summary>
The logger used to log messages.
</summary>
</member>
<member name="M:Amazon.Runtime.RetryPolicy.Retry(Amazon.Runtime.IExecutionContext,System.Exception)">
<summary>
Checks if a retry should be performed with the given execution context and exception.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
<param name="exception">The exception throw after issuing the request.</param>
<returns>Returns true if the request should be retried, else false.</returns>
</member>
<member name="M:Amazon.Runtime.RetryPolicy.CanRetry(Amazon.Runtime.IExecutionContext)">
<summary>
Returns true if the request is in a state where it can be retried, else false.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
<returns>Returns true if the request is in a state where it can be retried, else false.</returns>
</member>
<member name="M:Amazon.Runtime.RetryPolicy.RetryForException(Amazon.Runtime.IExecutionContext,System.Exception)">
<summary>
Return true if the request should be retried for the given exception.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
<param name="exception">The exception thrown by the previous request.</param>
<returns>Return true if the request should be retried.</returns>
</member>
<member name="M:Amazon.Runtime.RetryPolicy.RetryLimitReached(Amazon.Runtime.IExecutionContext)">
<summary>
Checks if the retry limit is reached.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
<returns>Return false if the request can be retried, based on number of retries.</returns>
</member>
<member name="M:Amazon.Runtime.RetryPolicy.WaitBeforeRetry(Amazon.Runtime.IExecutionContext)">
<summary>
Waits before retrying a request.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="T:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3">
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.GeneratePreSignedURL(System.String,System.String,System.DateTime,System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Generate a presigned URL.
</summary>
<param name="bucketName"></param>
<param name="objectKey"></param>
<param name="expiration"></param>
<param name="additionalProperties"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.GetAllObjectKeys(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Get all the object keys for the particular bucket and key prefix.
</summary>
<param name="bucketName"></param>
<param name="prefix"></param>
<param name="additionalProperties"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.Delete(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Delete the object.
</summary>
<param name="bucketName"></param>
<param name="objectKey"></param>
<param name="additionalProperties"></param>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.Deletes(System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Deletes the ojects.
</summary>
<param name="bucketName"></param>
<param name="objectKeys"></param>
<param name="additionalProperties"></param>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.UploadObjectFromStream(System.String,System.String,System.IO.Stream,System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Upload an object from a stream.
</summary>
<param name="bucketName"></param>
<param name="objectKey"></param>
<param name="stream"></param>
<param name="additionalProperties"></param>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.UploadObjectFromFilePath(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Upload an object from a file path.
</summary>
<param name="bucketName"></param>
<param name="objectKey"></param>
<param name="filepath"></param>
<param name="additionalProperties"></param>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.DownloadToFilePath(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Download object to a file path.
</summary>
<param name="bucketName"></param>
<param name="objectKey"></param>
<param name="filepath"></param>
<param name="additionalProperties"></param>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.GetObjectStream(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Get stream for an object.
</summary>
<param name="bucketName"></param>
<param name="objectKey"></param>
<param name="additionalProperties"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.MakeObjectPublic(System.String,System.String,System.Boolean)">
<summary>
Set the ACL on the object to public readable.
</summary>
<param name="bucketName"></param>
<param name="objectKey"></param>
<param name="enable"></param>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.EnsureBucketExists(System.String)">
<summary>
Check to see if the bucket exists and if it doesn't create the bucket.
</summary>
<param name="bucketName"></param>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.DoesS3BucketExist(System.String)">
<summary>
Check to see if the bucket exists.
</summary>
<param name="bucketName"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.UploadObjectFromStreamAsync(System.String,System.String,System.IO.Stream,System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.CancellationToken)">
<summary>
Upload an object from a stream.
</summary>
<param name="bucketName"></param>
<param name="objectKey"></param>
<param name="stream"></param>
<param name="additionalProperties"></param>
<param name="cancellationToken"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.DeleteAsync(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.CancellationToken)">
<summary>
Delete an object.
</summary>
<param name="bucketName"></param>
<param name="objectKey"></param>
<param name="additionalProperties"></param>
<param name="cancellationToken"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.GetObjectStreamAsync(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.CancellationToken)">
<summary>
Open a stream to an object in S3.
</summary>
<param name="bucketName"></param>
<param name="objectKey"></param>
<param name="additionalProperties"></param>
<param name="cancellationToken"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.UploadObjectFromFilePathAsync(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.CancellationToken)">
<summary>
Upload an object from a file path.
</summary>
<param name="bucketName"></param>
<param name="objectKey"></param>
<param name="filepath"></param>
<param name="additionalProperties"></param>
<param name="cancellationToken"></param>
<returns></returns>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonS3.DownloadToFilePathAsync(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.CancellationToken)">
<summary>
Download an object in S3 to a file path.
</summary>
<param name="bucketName"></param>
<param name="objectKey"></param>
<param name="filepath"></param>
<param name="additionalProperties"></param>
<param name="cancellationToken"></param>
<returns></returns>
</member>
<member name="T:Amazon.Runtime.SharedInterfaces.ICoreAmazonSQS">
<summary>
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.
</summary>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonSQS.GetAttributes(System.String)">
<summary>
Get the attributes for the queue identified by the queue URL.
</summary>
<param name="queueUrl">The queue URL to get attributes for.</param>
<returns>The attributes for the queue.</returns>
</member>
<member name="M:Amazon.Runtime.SharedInterfaces.ICoreAmazonSQS.SetAttributes(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
<summary>
Set the attributes on the queue identified by the queue URL.
</summary>
<param name="queueUrl">The queue URL to set the attributues.</param>
<param name="attributes">The attributes to set.</param>
</member>
<member name="T:Amazon.AWSSection">
<summary>
Root AWS config section
</summary>
</member>
<member name="P:Amazon.AWSSection.Proxy">
<summary>
Gets and sets the proxy settings for the SDK to use.
</summary>
</member>
<member name="T:Amazon.ProxySection">
<summary>
Settings for configuring a proxy for the SDK to use.
</summary>
</member>
<member name="P:Amazon.ProxySection.Host">
<summary>
Gets and sets the host name or IP address of the proxy server.
</summary>
</member>
<member name="P:Amazon.ProxySection.Port">
<summary>
Gets and sets the port number of the proxy.
</summary>
</member>
<member name="P:Amazon.ProxySection.Username">
<summary>
Gets and sets the username to authenticate with the proxy server.
</summary>
</member>
<member name="P:Amazon.ProxySection.Password">
<summary>
Gets and sets the password to authenticate with the proxy server.
</summary>
</member>
<member name="T:Amazon.LoggingSection">
<summary>
Logging section
</summary>
</member>
<member name="T:Amazon.WritableConfigurationElementCollection`1">
<summary>
Easy-to-use generic collection
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:Amazon.SerializableConfigurationElement">
<summary>
Configuration element that serializes properly when used with collections
</summary>
</member>
<member name="T:Amazon.WritableConfigurationElement">
<summary>
ConfigurationElement class which returns false for IsReadOnly
</summary>
</member>
<member name="T:Amazon.Util.ProxyConfig">
<summary>
Settings for configuring a proxy for the SDK to use.
</summary>
<summary>
Settings for configuring a proxy for the SDK to use.
</summary>
</member>
<member name="P:Amazon.Util.ProxyConfig.Host">
<summary>
The host name or IP address of the proxy server.
</summary>
</member>
<member name="P:Amazon.Util.ProxyConfig.Port">
<summary>
The port number of the proxy.
</summary>
</member>
<member name="P:Amazon.Util.ProxyConfig.Username">
<summary>
The username to authenticate with the proxy server.
</summary>
</member>
<member name="P:Amazon.Util.ProxyConfig.Password">
<summary>
The password to authenticate with the proxy server.
</summary>
</member>
<member name="T:Amazon.Util.LoggingConfig">
<summary>
Settings for logging in the SDK.
</summary>
<summary>
Settings for logging in the SDK.
</summary>
</member>
<member name="P:Amazon.Util.LoggingConfig.LogTo">
<summary>
Logging destination.
</summary>
</member>
<member name="P:Amazon.Util.LoggingConfig.LogResponses">
<summary>
When to log responses.
</summary>
</member>
<member name="P:Amazon.Util.LoggingConfig.LogResponsesSizeLimit">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Util.LoggingConfig.LogMetrics">
<summary>
Whether or not to log SDK metrics.
</summary>
</member>
<member name="P:Amazon.Util.LoggingConfig.LogMetricsCustomFormatter">
<summary>
A custom formatter added through Configuration
</summary>
</member>
<member name="T:Amazon.Util.AWSPublicIpAddressRanges">
<summary>
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.
</summary>
<remarks>
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.
</remarks>
</member>
<member name="F:Amazon.Util.AWSPublicIpAddressRanges.GlobalRegionIdentifier">
<summary>
Region identifier string for ROUTE53 and CLOUDFRONT ranges
</summary>
</member>
<member name="P:Amazon.Util.AWSPublicIpAddressRanges.ServiceKeys">
<summary>
Collection of service keys found in the data file.
</summary>
</member>
<member name="P:Amazon.Util.AWSPublicIpAddressRanges.CreateDate">
<summary>
The publication date and time of the file that was downloaded and parsed.
</summary>
</member>
<member name="P:Amazon.Util.AWSPublicIpAddressRanges.AllAddressRanges">
<summary>
Collection of all public IP ranges.
</summary>
</member>
<member name="M:Amazon.Util.AWSPublicIpAddressRanges.AddressRangesByServiceKey(System.String)">
<summary>
Filtered collection of public IP ranges for the given service key
</summary>
</member>
<member name="M:Amazon.Util.AWSPublicIpAddressRanges.AddressRangesByRegion(System.String)">
<summary>
Filtered collection of public IP ranges for the given region (us-east-1 etc) or GLOBAL.
</summary>
</member>
<member name="M:Amazon.Util.AWSPublicIpAddressRanges.Load">
<summary>
Downloads the most recent copy of the endpoint address file and
parses it to a collection of address range objects.
</summary>
</member>
<member name="T:Amazon.Util.AWSPublicIpAddressRange">
<summary>
Represents the IP address range for a single region and service key.
</summary>
</member>
<member name="P:Amazon.Util.AWSPublicIpAddressRange.IpPrefix">
<summary>
The public IP address range, in CIDR notation.
</summary>
</member>
<member name="P:Amazon.Util.AWSPublicIpAddressRange.Region">
<summary>
The AWS region or GLOBAL for edge locations. Note that the CLOUDFRONT and ROUTE53
ranges are GLOBAL.
</summary>
</member>
<member name="P:Amazon.Util.AWSPublicIpAddressRange.Service">
<summary>
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.
</summary>
<remarks>
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!
</remarks>
</member>
<member name="T:Amazon.Util.AWSSDKUtils">
<summary>
This class defines utilities and constants that can be used by
all the client libraries of the SDK.
</summary>
</member>
<member name="F:Amazon.Util.AWSSDKUtils.UserAgentHeader">
<summary>
The user agent string header
</summary>
</member>
<member name="F:Amazon.Util.AWSSDKUtils.ValidUrlCharacters">
<summary>
The Set of accepted and valid Url characters per RFC3986.
Characters outside of this set will be encoded.
</summary>
</member>
<member name="F:Amazon.Util.AWSSDKUtils.ValidUrlCharactersRFC1738">
<summary>
The Set of accepted and valid Url characters per RFC1738.
Characters outside of this set will be encoded.
</summary>
</member>
<member name="F:Amazon.Util.AWSSDKUtils.ValidPathCharacters">
<summary>
The set of accepted and valid Url path characters per RFC3986.
</summary>
</member>
<member name="F:Amazon.Util.AWSSDKUtils.UrlEncodedContent">
<summary>
The string representing Url Encoded Content in HTTP requests
</summary>
</member>
<member name="F:Amazon.Util.AWSSDKUtils.GMTDateFormat">
<summary>
The GMT Date Format string. Used when parsing date objects
</summary>
</member>
<member name="F:Amazon.Util.AWSSDKUtils.ISO8601DateFormat">
<summary>
The ISO8601Date Format string. Used when parsing date objects
</summary>
</member>
<member name="F:Amazon.Util.AWSSDKUtils.ISO8601DateFormatNoMS">
<summary>
The ISO8601Date Format string. Used when parsing date objects
</summary>
</member>
<member name="F:Amazon.Util.AWSSDKUtils.ISO8601BasicDateTimeFormat">
<summary>
The ISO8601 Basic date/time format string. Used when parsing date objects
</summary>
</member>
<member name="F:Amazon.Util.AWSSDKUtils.ISO8601BasicDateFormat">
<summary>
The ISO8601 basic date format. Used during AWS4 signature computation.
</summary>
</member>
<member name="F:Amazon.Util.AWSSDKUtils.RFC822DateFormat">
<summary>
The RFC822Date Format string. Used when parsing date objects
</summary>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.GetExtension(System.String)">
<summary>
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.
</summary>
<param name="path"></param>
<returns></returns>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.GetParametersAsString(System.Collections.Generic.IDictionary{System.String,System.String})">
Convert Dictionary of paremeters to Url encoded query string
</member>
<member name="M:Amazon.Util.AWSSDKUtils.CanonicalizeResourcePath(System.Uri,System.String)">
<summary>
Returns the canonicalized resource path for the service endpoint
</summary>
<param name="endpoint">Endpoint URL for the request</param>
<param name="resourcePath">Resource path for the request</param>
<remarks>
If resourcePath begins or ends with slash, the resulting canonicalized
path will follow suit.
</remarks>
<returns>Canonicalized resource path for the endpoint</returns>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.Join(System.Collections.Generic.List{System.String})">
<summary>
Returns a new string created by joining each of the strings in the
specified list together, with a comma between them.
</summary>
<parma name="strings">The list of strings to join into a single, comma delimited
string list.</parma>
<returns> A new string created by joining each of the strings in the
specified list together, with a comma between strings.</returns>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.DetermineRegion(System.String)">
<summary>
Attempt to infer the region for a service request based on the endpoint
</summary>
<param name="url">Endpoint to the service to be called</param>
<returns>
Region parsed from the endpoint; DefaultRegion (or DefaultGovRegion)
if it cannot be determined/is not explicit
</returns>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.DetermineService(System.String)">
<summary>
Attempt to infer the service name for a request (in short form, eg 'iam') from the
service endpoint.
</summary>
<param name="url">Endpoint to the service to be called</param>
<returns>
Short-form name of the service parsed from the endpoint; empty string if it cannot
be determined
</returns>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.ConvertFromUnixEpochSeconds(System.Int32)">
<summary>
Utility method for converting Unix epoch seconds to DateTime structure.
</summary>
<param name="seconds">The number of seconds since January 1, 1970.</param>
<returns>Converted DateTime structure</returns>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.ToHex(System.Byte[],System.Boolean)">
<summary>
Helper function to format a byte array into string
</summary>
<param name="data">The data blob to process</param>
<param name="lowercase">If true, returns hex digits in lower case form</param>
<returns>String version of the data</returns>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.InvokeInBackground``1(System.EventHandler{``0},``0,System.Object)">
<summary>
Calls a specific EventHandler in a background thread
</summary>
<param name="handler"></param>
<param name="args"></param>
<param name="sender"></param>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.ParseQueryParameters(System.String)">
<summary>
Parses a query string of a URL and returns the parameters as a string-to-string dictionary.
</summary>
<param name="url"></param>
<returns></returns>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.GenerateMemoryStreamFromString(System.String)">
<summary>
Utility method for converting a string to a MemoryStream.
</summary>
<param name="s"></param>
<returns></returns>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.CopyStream(System.IO.Stream,System.IO.Stream)">
<summary>
Utility method for copy the contents of the source stream to the destination stream.
</summary>
<param name="source"></param>
<param name="destination"></param>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.CopyStream(System.IO.Stream,System.IO.Stream,System.Int32)">
<summary>
Utility method for copy the contents of the source stream to the destination stream.
</summary>
<param name="source"></param>
<param name="destination"></param>
<param name="bufferSize"></param>
</member>
<member name="P:Amazon.Util.AWSSDKUtils.FormattedCurrentTimestampGMT">
<summary>
Formats the current date as a GMT timestamp
</summary>
<returns>A GMT formatted string representation
of the current date and time
</returns>
</member>
<member name="P:Amazon.Util.AWSSDKUtils.FormattedCurrentTimestampISO8601">
<summary>
Formats the current date as ISO 8601 timestamp
</summary>
<returns>An ISO 8601 formatted string representation
of the current date and time
</returns>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.GetFormattedTimestampISO8601(System.Int32)">
<summary>
Gets the ISO8601 formatted timestamp that is minutesFromNow
in the future.
</summary>
<param name="minutesFromNow">The number of minutes from the current instant
for which the timestamp is needed.</param>
<returns>The ISO8601 formatted future timestamp.</returns>
</member>
<member name="P:Amazon.Util.AWSSDKUtils.FormattedCurrentTimestampRFC822">
<summary>
Formats the current date as ISO 8601 timestamp
</summary>
<returns>An ISO 8601 formatted string representation
of the current date and time
</returns>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.GetFormattedTimestampRFC822(System.Int32)">
<summary>
Gets the RFC822 formatted timestamp that is minutesFromNow
in the future.
</summary>
<param name="minutesFromNow">The number of minutes from the current instant
for which the timestamp is needed.</param>
<returns>The ISO8601 formatted future timestamp.</returns>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.UrlEncode(System.String,System.Boolean)">
<summary>
URL encodes a string per RFC3986. If the path property is specified,
the accepted path characters {/+:} are not encoded.
</summary>
<param name="data">The string to encode</param>
<param name="path">Whether the string is a URL path or not</param>
<returns>The encoded string</returns>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.UrlEncode(System.Int32,System.String,System.Boolean)">
<summary>
URL encodes a string per the specified RFC. If the path property is specified,
the accepted path characters {/+:} are not encoded.
</summary>
<param name="rfcNumber">RFC number determing safe characters</param>
<param name="data">The string to encode</param>
<param name="path">Whether the string is a URL path or not</param>
<returns>The encoded string</returns>
<remarks>
Currently recognised RFC versions are 1738 (Dec '94) and 3986 (Jan '05).
If the specified RFC is not recognised, 3986 is used by default.
</remarks>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.BytesToHexString(System.Byte[])">
<summary>
Convert bytes to a hex string
</summary>
<param name="value">Bytes to convert.</param>
<returns>Hexadecimal string representing the byte array.</returns>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.HexStringToBytes(System.String)">
<summary>
Convert a hex string to bytes
</summary>
<param name="hex">Hexadecimal string</param>
<returns>Byte array corresponding to the hex string.</returns>
</member>
<member name="P:Amazon.Util.AWSSDKUtils.CorrectedUtcNow">
<summary>
Returns DateTime.UtcNow + ClockOffset when
<seealso cref="P:Amazon.AWSConfigs.CorrectForClockSkew"/> is true.
This value should be used when constructing requests, as it
will represent accurate time w.r.t. AWS servers.
</summary>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.HasBidiControlCharacters(System.String)">
<summary>
Returns true if the string has any bidirectional control characters.
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:Amazon.Util.AWSSDKUtils.PreserveStackTrace(System.Exception)">
<summary>
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.
</summary>
<param name="exception"></param>
</member>
<member name="T:Amazon.Util.CircularReferenceTracking">
<summary>
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.
</summary>
</member>
<member name="T:Amazon.Util.CircularReferenceTracking.Tracker">
<summary>
Tracker. Must be disposed.
</summary>
</member>
<member name="M:Amazon.Util.CircularReferenceTracking.Tracker.Dispose(System.Boolean)">
<summary>
Implements the Dispose pattern
</summary>
<param name="disposing">Whether this object is being disposed via a call to Dispose
or garbage collected.</param>
</member>
<member name="M:Amazon.Util.CircularReferenceTracking.Tracker.Dispose">
<summary>
Disposes of all managed and unmanaged resources.
</summary>
</member>
<member name="M:Amazon.Util.CircularReferenceTracking.Track(System.Object)">
<summary>
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.
</summary>
<param name="target"></param>
<returns></returns>
</member>
<member name="T:Amazon.Util.Internal.RootConfig">
<summary>
Root AWS config
</summary>
</member>
<member name="T:Amazon.Util.ProfileManager">
<summary>
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.
<para>
The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API.
</para>
<para>
To reference a profile from an application's App.config or Web.config use the AWSProfileName setting.
<code>
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="development"/>
</appSettings>
</configuration>
</code>
</para>
</summary>
</member>
<member name="M:Amazon.Util.ProfileManager.RegisterProfile(System.String,System.String,System.String)">
<summary>
Registers an AWS credentials profile that can later be referenced by the profileName.
This profile will only be visible for the current user.
</summary>
<param name="profileName">Name given to the AWS credentials.</param>
<param name="accessKeyId">The AWS access key id</param>
<param name="secretKey">The AWS secret key</param>
</member>
<member name="M:Amazon.Util.ProfileManager.RegisterSAMLRoleProfile(System.String,System.String,System.String,System.String)">
<summary>
<para>
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.
</para>
<para>
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.
</para>
</summary>
<param name="profileName">Name to be assigned to the profile</param>
<param name="endpointName">
The name assigned to the endpoint settings, previously saved with RegisterSAMLEndpoint.
</param>
<param name="roleArn">
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.
</param>
<param name="userIdentity">
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.
</param>
</member>
<member name="M:Amazon.Util.ProfileManager.RegisterSAMLEndpoint(System.String,System.Uri,System.String)">
<summary>
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.
</summary>
<param name="endpointName">Name to be assigned to the endpoint settings.</param>
<param name="endpoint">The full uri of the authentication endpoint.</param>
<param name="authenticationType">
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'.
</param>
<returns>The unique id assigned to the new settings.</returns>
</member>
<member name="M:Amazon.Util.ProfileManager.UnregisterProfile(System.String)">
<summary>
Deletes the settings for an AWS credentials or SAML role profile from the SDK account store.
</summary>
<param name="profileName">The name of the profile to remove.</param>
</member>
<member name="M:Amazon.Util.ProfileManager.ListProfileNames">
<summary>
Lists all profile names registered with the SDK account store.
</summary>
<returns>The profile names.</returns>
</member>
<member name="M:Amazon.Util.ProfileManager.ListProfiles">
<summary>
Loads and returns all available credential profiles registered in the store.
</summary>
<returns>Collection of profiles.</returns>
</member>
<member name="M:Amazon.Util.ProfileManager.IsProfileKnown(System.String)">
<summary>
Checks if a given profile is known in the SDK credential store.
</summary>
<param name="profileName">The name of the profile to test for existence</param>
<returns>True if the profile exists.</returns>
</member>
<member name="M:Amazon.Util.ProfileManager.CopyProfileSettings(System.String,System.String)">
<summary>
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.
</summary>
<param name="sourceProfileName">The name of the profile to copy from.</param>
<param name="destinationProfileName">The name of the profile to create or update.</param>
<returns>The unique id assigned to the destination settings.</returns>
</member>
<member name="M:Amazon.Util.ProfileManager.CopyProfileSettings(Amazon.Runtime.Internal.Settings.SettingsCollection.ObjectSettings,System.String)">
<summary>
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.
</summary>
<param name="source">The source profile to copy keys and values from.</param>
<param name="destinationProfileName">The name of the profile to create or update.</param>
<returns>The unique id assigned to the destination settings.</returns>
</member>
<member name="M:Amazon.Util.ProfileManager.TryGetAWSCredentials(System.String,Amazon.Runtime.AWSCredentials@)">
<summary>
Tries to get the AWS credentials from a profile in the SDK account store.
</summary>
<param name="profileName">The profile to get the credentials for.</param>
<param name="credentials">Outputs the credentials for the profile.</param>
<returns>Returns true if the profile exists otherwise false is returned.</returns>
</member>
<member name="M:Amazon.Util.ProfileManager.GetAWSCredentials(System.String)">
<summary>
Gets the AWS credentials from a profile in the SDK account store.
</summary>
<param name="profileName">The profile to get the credentials for.</param>
<returns>The AWS credentials for the profile.</returns>
<exception cref="T:Amazon.Runtime.AmazonClientException">Thrown if the profile does not exist</exception>
</member>
<member name="M:Amazon.Util.ProfileManager.GetProfile(System.String)">
<summary>
Returns the profile with the specified name, if it has been registered.
</summary>
<param name="profileName">The name of the registered profile</param>
<returns>The loaded profile data</returns>
</member>
<member name="M:Amazon.Util.ProfileManager.GetProfile``1(System.String)">
<summary>
Returns the persisted data a profile of the specified type T.
</summary>
<param name="profileName">The name of the profile holding the settings.</param>
<returns>The loaded profile. An exception is thrown if the profile could not be loaded.</returns>
<exception cref="T:Amazon.Runtime.AmazonClientException">Thrown if the profile does not exist</exception>
<remarks>
Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile.
</remarks>
</member>
<member name="M:Amazon.Util.ProfileManager.TryGetProfile``1(System.String,``0@)">
<summary>
Tries to load the specified profile data corresponding to profile type T from a named
profile in the SDK account store.
</summary>
<param name="profileName">The name of the profile holding the settings.</param>
<param name="profile">The loaded profile data.</param>
<returns>Returns true if the profile exists otherwise false is returned.</returns>
<remarks>
Currently supported profile types: AWSCredentialsProfile and SAMLRoleProfile.
</remarks>
</member>
<member name="M:Amazon.Util.ProfileManager.TryGetSAMLEndpoint(System.String,Amazon.Util.SAMLEndpointSettings@)">
<summary>
Attempts to load the settings defining a SAML endpoint.
</summary>
<param name="endpointName">The name assigned to the settings for the endpoint.</param>
<param name="endpointSettings">The instantiated endpoint.</param>
<returns>True if the settings were successfully loaded.</returns>
</member>
<member name="M:Amazon.Util.ProfileManager.GetSAMLEndpoint(System.String)">
<summary>
Loads the settings defining a SAML endpoint.
</summary>
<param name="endpointName">The name assigned to the settings for the endpoint.</param>
<returns>The loaded settings. An exception is thrown if they could not be loaded.</returns>
<exception cref="T:Amazon.Runtime.AmazonClientException">Thrown if the endpoint settings do not exist.</exception>
</member>
<member name="T:Amazon.Util.ProfileSettingsBase">
<summary>
Common base contract for all types of credential and role profiles.
</summary>
</member>
<member name="P:Amazon.Util.ProfileSettingsBase.Name">
<summary>
The user-defined name for the settings.
</summary>
</member>
<member name="P:Amazon.Util.ProfileSettingsBase.UniqueId">
<summary>
The unique id of the profile in the backing store.
</summary>
</member>
<member name="M:Amazon.Util.ProfileSettingsBase.Persist">
<summary>
Saves the profile data to backing store, returning the unique id
assigned to the data.
</summary>
</member>
<member name="T:Amazon.Util.AWSCredentialsProfile">
<summary>
The persisted data for a set of AWS credentials. At a minimum this
is access key and secret key data.
</summary>
</member>
<member name="M:Amazon.Util.AWSCredentialsProfile.CanCreateFrom(System.String)">
<summary>
Tests if an AWSCredentialsProfile instance could be instantiated from
the persisted settings data.
</summary>
<param name="profileName">The name given to the persisted settings.</param>
<returns>True if the settings are compatible with an AWSCredentialsProfile type.</returns>
</member>
<member name="M:Amazon.Util.AWSCredentialsProfile.CanCreateFrom(Amazon.Runtime.Internal.Settings.SettingsCollection.ObjectSettings)">
<summary>
Tests if an AWSCredentialsProfile instance could be instantiated from
the persisted settings data.
</summary>
<param name="os">The persisted settings.</param>
<returns>True if the settings are compatible with an AWSCredentialsProfile type.</returns>
</member>
<member name="M:Amazon.Util.AWSCredentialsProfile.LoadFrom(System.String)">
<summary>
Instantiates an AWSCredentialsProfile instance from the specified profile name.
</summary>
<param name="profileName">The name of the profile holding the settings.</param>
<returns>New credentials profile instance. An exception is thrown if the profile data is invalid.</returns>
</member>
<member name="M:Amazon.Util.AWSCredentialsProfile.LoadFrom(Amazon.Runtime.Internal.Settings.SettingsCollection.ObjectSettings)">
<summary>
Instantiates an AWSCredentialsProfile instance from the supplied settings collection.
</summary>
<param name="os">The settings representing the stored profile.</param>
<returns>New credentials profile instance. An exception is thrown if the profile data is invalid.</returns>
</member>
<member name="M:Amazon.Util.AWSCredentialsProfile.Validate(System.String)">
<summary>
Validates the contents of the specified profile.
</summary>
<param name="profileName">The name of the AWS credentials profile to validate.</param>
<exception cref="T:System.IO.InvalidDataException">Thrown if the profile settings fail to validate.</exception>
</member>
<member name="M:Amazon.Util.AWSCredentialsProfile.Validate(Amazon.Runtime.Internal.Settings.SettingsCollection.ObjectSettings)">
<summary>
Verifies that the persisted settings contains the minimal viable data to
instantiate an AWSCredentialsProfile instance.
</summary>
<param name="os">The persisted settings.</param>
<exception cref="T:System.IO.InvalidDataException">Thrown if the profile settings fail to validate.</exception>
</member>
<member name="M:Amazon.Util.AWSCredentialsProfile.Persist">
<summary>
Persists the profile data to the store file.
</summary>
<returns>The unique ID assigned to the settings.</returns>
</member>
<member name="M:Amazon.Util.AWSCredentialsProfile.Persist(System.String,System.String,System.String)">
<summary>
Creates or updates the profile data in the store file.
</summary>
<returns>The unique ID assigned to the settings.</returns>
</member>
<member name="T:Amazon.Util.SAMLEndpointSettings">
<summary>
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.
</summary>
</member>
<member name="F:Amazon.Util.SAMLEndpointSettings.DefaultAuthenticationType">
<summary>
The default authentication type to use when attempting to perform an
authentication call against the configured endpoint.
</summary>
</member>
<member name="P:Amazon.Util.SAMLEndpointSettings.Endpoint">
<summary>
The authentication endpoint which must be a HTTPS scheme.
</summary>
</member>
<member name="P:Amazon.Util.SAMLEndpointSettings.AuthenticationType">
<summary>
The authentication type to use when calling the endpoint.
</summary>
</member>
<member name="M:Amazon.Util.SAMLEndpointSettings.CanCreateFrom(System.String)">
<summary>
Tests if a SAMLEndpointSettings instance could be instantiated from
the persisted settings data.
</summary>
<param name="endpointName">The name given to the persisted settings.</param>
<returns>True if the settings are compatible.</returns>
</member>
<member name="M:Amazon.Util.SAMLEndpointSettings.CanCreateFrom(Amazon.Runtime.Internal.Settings.SettingsCollection.ObjectSettings)">
<summary>
Tests if a SAMLEndpointSettings instance could be instantiated from
the persisted settings data.
</summary>
<param name="os">The persisted settings.</param>
<returns>True if the settings are compatible.</returns>
</member>
<member name="M:Amazon.Util.SAMLEndpointSettings.LoadFrom(System.String)">
<summary>
Instantiates an instance from settings stored with the specified name.
</summary>
<param name="endpointName">The name of the endpoint settings in the store.</param>
<returns>Profile instance or an exception if the profile data does not exist/contains invalid data.</returns>
</member>
<member name="M:Amazon.Util.SAMLEndpointSettings.LoadFrom(Amazon.Runtime.Internal.Settings.SettingsCollection.ObjectSettings)">
<summary>
Instantiates an instance from the supplied settings.
</summary>
<param name="os">The persisted settings.</param>
<returns>Profile instance or an exception if the profile data is invalid.</returns>
</member>
<member name="M:Amazon.Util.SAMLEndpointSettings.Validate(System.String)">
<summary>
Validates the contents of the specified endpoint settings.
</summary>
<param name="endpointName">The name of the SAML endpoint settings to validate.</param>
<exception cref="T:System.IO.InvalidDataException">Thrown if the settings fail to validate.</exception>
</member>
<member name="M:Amazon.Util.SAMLEndpointSettings.Validate(Amazon.Runtime.Internal.Settings.SettingsCollection.ObjectSettings)">
<summary>
Verifies that the persisted settings contains the minimal viable data to
instantiate a SAMLEndpointSettings instance.
</summary>
<param name="os">The persisted settings.</param>
<exception cref="T:System.IO.InvalidDataException">Thrown if the settings fail to validate.</exception>
</member>
<member name="M:Amazon.Util.SAMLEndpointSettings.Persist">
<summary>
Persists the settings to the storage file.
</summary>
<returns>The unique id assigned to the profile</returns>
</member>
<member name="M:Amazon.Util.SAMLEndpointSettings.Persist(System.String,System.Uri,System.String)">
<summary>
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.
</summary>
<param name="settingsName">The name of the settings to create or update</param>
<param name="endpoint">The authentication endpoint</param>
<param name="authenticationType">Optional authentication type to use when performing calls against the endpoint</param>
<returns>The unique id assigned to the profile</returns>
</member>
<member name="M:Amazon.Util.SAMLEndpointSettings.#ctor(System.String,System.Uri,System.String)">
<summary>
Constructs an endpoint settings instance.
</summary>
<param name="settingsName">The user-defined name to assign to the settings.</param>
<param name="endpoint">
The absolute uri, including any query and relyingParty data, of the endpoint.
</param>
<param name="authenticationType">
The authentication type to use when performing requests against the endpoint.
</param>
</member>
<member name="T:Amazon.Util.SAMLRoleProfile">
<summary>
<para>
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.
</para>
<para>
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).
</para>
</summary>
</member>
<member name="P:Amazon.Util.SAMLRoleProfile.RoleArn">
<summary>
The ARN of the role that is to be assumed.
</summary>
</member>
<member name="P:Amazon.Util.SAMLRoleProfile.UserIdentity">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Util.SAMLRoleProfile.UseDefaultUserIdentity">
<summary>
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.
</summary>
</member>
<member name="P:Amazon.Util.SAMLRoleProfile.EndpointSettings">
<summary>
The endpoint settings from which the actual endpoint to use in authentication
is obtained.
</summary>
</member>
<member name="M:Amazon.Util.SAMLRoleProfile.CanCreateFrom(System.String)">
<summary>
Tests if a SAMLRoleProfile instance could be instantiated from
the persisted settings data.
</summary>
<param name="profileName">The name given to the persisted settings.</param>
<returns>True if the settings are compatible with a SAMLRoleProfile type.</returns>
</member>
<member name="M:Amazon.Util.SAMLRoleProfile.CanCreateFrom(Amazon.Runtime.Internal.Settings.SettingsCollection.ObjectSettings)">
<summary>
Tests if a SAMLRoleProfile instance could be instantiated from
the persisted settings data.
</summary>
<param name="os">The persisted settings.</param>
<returns>True if the settings are compatible with a SAMLRoleProfile type.</returns>
</member>
<member name="M:Amazon.Util.SAMLRoleProfile.LoadFrom(System.String)">
<summary>
Instantiates an instance from settings stored with the specified name.
</summary>
<param name="profileName">The name of the endpoint profile.</param>
<returns>Profile instance or an exception if the profile data does not exist/contains invalid data.</returns>
</member>
<member name="M:Amazon.Util.SAMLRoleProfile.LoadFrom(Amazon.Runtime.Internal.Settings.SettingsCollection.ObjectSettings)">
<summary>
Instantiates an instance from the supplied settings.
</summary>
<param name="os">The persisted settings.</param>
<returns>Profile instance or an exception if the profile data is invalid.</returns>
</member>
<member name="M:Amazon.Util.SAMLRoleProfile.Validate(System.String)">
<summary>
Validates the contents of the specified profile.
</summary>
<param name="profileName">The name of the SAML role profile to validate.</param>
<exception cref="T:System.IO.InvalidDataException">Thrown if the profile settings fail to validate.</exception>
</member>
<member name="M:Amazon.Util.SAMLRoleProfile.Validate(Amazon.Runtime.Internal.Settings.SettingsCollection.ObjectSettings)">
<summary>
Validates that the presented settings would result in a valid role profile
instance.
</summary>
<param name="os">The persisted settings.</param>
<exception cref="T:System.IO.InvalidDataException">Thrown if the profile settings fail to validate.</exception>
</member>
<member name="M:Amazon.Util.SAMLRoleProfile.Persist">
<summary>
Stores the data in the role profile to the backing store file.
</summary>
</member>
<member name="M:Amazon.Util.SAMLRoleProfile.Persist(System.String,System.String,System.String,System.String)">
<summary>
<para>
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.
</para>
<para>
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.
</para>
</summary>
<param name="profileName">Name to be assigned to the profile</param>
<param name="endpointSettingsName">
The name of the settings in the SAML endpoints file containing details of the
endpoint to authenticate with.
</param>
<param name="roleArn">
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.
</param>
<param name="userIdentity">
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.
</param>
<returns>The unique id assigned to the profile.</returns>
</member>
<member name="M:Amazon.Util.SAMLRoleProfile.#ctor(System.String,Amazon.Util.SAMLEndpointSettings,System.String,System.String)">
<summary>
Constructs a profile data instance that will use the specified network identity
during authentication with configured endpoint.
</summary>
<param name="profileName">The user-defined name of the profile that sourced this data.</param>
<param name="endpointSettings">The settings for the authentication endpoint.</param>
<param name="roleArn">The role that should be assumed on successful authentication.</param>
<param name="userIdentity">The credentials to supply in authentication, in domain\user format.</param>
</member>
<member name="T:ThirdParty.Ionic.Zlib.CRC32">
<summary>
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.
</summary>
</member>
<member name="P:ThirdParty.Ionic.Zlib.CRC32.TotalBytesRead">
<summary>
indicates the total number of bytes read on the CRC stream.
This is used when writing the ZipDirEntry when compressing files.
</summary>
</member>
<member name="P:ThirdParty.Ionic.Zlib.CRC32.Crc32Result">
<summary>
Indicates the current CRC for all blocks slurped in.
</summary>
</member>
<member name="M:ThirdParty.Ionic.Zlib.CRC32.GetCrc32(System.IO.Stream)">
<summary>
Returns the CRC32 for the specified stream.
</summary>
<param name="input">The stream over which to calculate the CRC32</param>
<returns>the CRC32 calculation</returns>
</member>
<member name="M:ThirdParty.Ionic.Zlib.CRC32.GetCrc32AndCopy(System.IO.Stream,System.IO.Stream)">
<summary>
Returns the CRC32 for the specified stream, and writes the input into the output stream.
</summary>
<param name="input">The stream over which to calculate the CRC32</param>
<param name="output">The stream into which to deflate the input</param>
<returns>the CRC32 calculation</returns>
</member>
<member name="M:ThirdParty.Ionic.Zlib.CRC32.ComputeCrc32(System.Int32,System.Byte)">
<summary>
Get the CRC32 for the given (word,byte) combo.
This is a computation defined by PKzip.
</summary>
<param name="W">The word to start with.</param>
<param name="B">The byte to combine it with.</param>
<returns>The CRC-ized result.</returns>
</member>
<member name="M:ThirdParty.Ionic.Zlib.CRC32.SlurpBlock(System.Byte[],System.Int32,System.Int32)">
<summary>
Update the value for the running CRC32 using the given block of bytes.
This is useful when using the CRC32() class in a Stream.
</summary>
<param name="block">block of bytes to slurp</param>
<param name="offset">starting point in the block</param>
<param name="count">how many bytes within the block to slurp</param>
</member>
<member name="T:ThirdParty.Ionic.Zlib.CrcCalculatorStream">
<summary>
A Stream that calculates a CRC32 (a checksum) on all bytes read,
or on all bytes written.
</summary>
<remarks>
<para>
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.
</para>
<para>This class is intended primarily for use internally by the DotNetZip library.</para>
</remarks>
</member>
<member name="P:ThirdParty.Ionic.Zlib.CrcCalculatorStream.TotalBytesSlurped">
<summary>
Gets the total number of bytes run through the CRC32 calculator.
</summary>
<remarks>
This is either the total number of bytes read, or the total number
of bytes written, depending on the direction of this stream.
</remarks>
</member>
<member name="M:ThirdParty.Ionic.Zlib.CrcCalculatorStream.#ctor(System.IO.Stream)">
<summary>
The constructor.
</summary>
<param name="stream">The underlying stream</param>
</member>
<member name="M:ThirdParty.Ionic.Zlib.CrcCalculatorStream.#ctor(System.IO.Stream,System.Int64)">
<summary>
The constructor.
</summary>
<param name="stream">The underlying stream</param>
<param name="length">The length of the stream to slurp</param>
</member>
<member name="P:ThirdParty.Ionic.Zlib.CrcCalculatorStream.Crc32">
<summary>
Provides the current CRC for all blocks slurped in.
</summary>
</member>
<member name="M:ThirdParty.Ionic.Zlib.CrcCalculatorStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Read from the stream
</summary>
<param name="buffer">the buffer to read</param>
<param name="offset">the offset at which to start</param>
<param name="count">the number of bytes to read</param>
<returns>the number of bytes actually read</returns>
</member>
<member name="M:ThirdParty.Ionic.Zlib.CrcCalculatorStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write to the stream.
</summary>
<param name="buffer">the buffer from which to write</param>
<param name="offset">the offset at which to start writing</param>
<param name="count">the number of bytes to write</param>
</member>
<member name="P:ThirdParty.Ionic.Zlib.CrcCalculatorStream.CanRead">
<summary>
Indicates whether the stream supports reading.
</summary>
</member>
<member name="P:ThirdParty.Ionic.Zlib.CrcCalculatorStream.CanSeek">
<summary>
Indicates whether the stream supports seeking.
</summary>
</member>
<member name="P:ThirdParty.Ionic.Zlib.CrcCalculatorStream.CanWrite">
<summary>
Indicates whether the stream supports writing.
</summary>
</member>
<member name="M:ThirdParty.Ionic.Zlib.CrcCalculatorStream.Flush">
<summary>
Flush the stream.
</summary>
</member>
<member name="P:ThirdParty.Ionic.Zlib.CrcCalculatorStream.Length">
<summary>
Not implemented.
</summary>
</member>
<member name="P:ThirdParty.Ionic.Zlib.CrcCalculatorStream.Position">
<summary>
Not implemented.
</summary>
</member>
<member name="M:ThirdParty.Ionic.Zlib.CrcCalculatorStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Not implemented.
</summary>
<param name="offset">N/A</param>
<param name="origin">N/A</param>
<returns>N/A</returns>
</member>
<member name="M:ThirdParty.Ionic.Zlib.CrcCalculatorStream.SetLength(System.Int64)">
<summary>
Not implemented.
</summary>
<param name="value">N/A</param>
</member>
<member name="T:ThirdParty.BouncyCastle.Asn1.Asn1InputStream">
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.
</member>
<member name="M:ThirdParty.BouncyCastle.Asn1.Asn1InputStream.#ctor(System.IO.Stream,System.Int32)">
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.
</member>
<member name="M:ThirdParty.BouncyCastle.Asn1.Asn1InputStream.#ctor(System.Byte[])">
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.
</member>
<member name="M:ThirdParty.BouncyCastle.Asn1.Asn1InputStream.BuildObject(System.Int32,System.Int32,System.Int32)">
build an object given its tag and the number of bytes to construct it from.
</member>
<member name="M:ThirdParty.BouncyCastle.Asn1.Asn1Object.FromByteArray(System.Byte[])">
<summary>Create a base ASN.1 object from a byte array.</summary>
<param name="data">The byte array to parse.</param>
<returns>The base ASN.1 object represented by the byte array.</returns>
<exception cref="T:System.IO.IOException">If there is a problem parsing the data.</exception>
</member>
<member name="M:ThirdParty.BouncyCastle.Asn1.Asn1Object.FromStream(System.IO.Stream)">
<summary>Read a base ASN.1 object from a stream.</summary>
<param name="inStr">The stream to parse.</param>
<returns>The base ASN.1 object represented by the byte array.</returns>
<exception cref="T:System.IO.IOException">If there is a problem parsing the data.</exception>
</member>
<member name="P:ThirdParty.BouncyCastle.Asn1.Asn1Sequence.Item(System.Int32)">
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.
</member>
<member name="M:ThirdParty.BouncyCastle.Asn1.DerSequence.#ctor">
create an empty sequence
</member>
<member name="M:ThirdParty.BouncyCastle.Asn1.DerSequence.#ctor(ThirdParty.BouncyCastle.Asn1.Asn1Encodable)">
create a sequence containing one object
</member>
<member name="M:ThirdParty.BouncyCastle.Asn1.DerSequence.#ctor(ThirdParty.BouncyCastle.Asn1.Asn1EncodableVector)">
create a sequence containing a vector of objects.
</member>
<member name="M:ThirdParty.BouncyCastle.Math.BigInteger.AddMagnitudes(System.Int32[],System.Int32[])">
return a = a + b - b preserved.
</member>
<member name="M:ThirdParty.BouncyCastle.Math.BigInteger.CompareTo(System.Int32,System.Int32[],System.Int32,System.Int32[])">
unsigned comparison on two arrays - note the arrays may
start with leading zeros.
</member>
<member name="M:ThirdParty.BouncyCastle.Math.BigInteger.Subtract(System.Int32,System.Int32[],System.Int32,System.Int32[])">
returns x = x - y - we assume x is >= y
</member>
<member name="M:ThirdParty.BouncyCastle.Utilities.IO.Pem.PemObjectGenerator.Generate">
<returns>
A <see cref="T:ThirdParty.BouncyCastle.Utilities.IO.Pem.PemObject"/>
</returns>
<exception cref="T:ThirdParty.BouncyCastle.Utilities.IO.Pem.PemGenerationException"></exception>
</member>
<member name="M:ThirdParty.BouncyCastle.Utilities.IO.Pem.PemObjectParser.ParseObject(ThirdParty.BouncyCastle.Utilities.IO.Pem.PemObject)">
<param name="obj">
A <see cref="T:ThirdParty.BouncyCastle.Utilities.IO.Pem.PemObject"/>
</param>
<returns>
A <see cref="T:System.Object"/>
</returns>
<exception cref="T:System.IO.IOException"></exception>
</member>
<member name="M:ThirdParty.BouncyCastle.Utilities.IO.Pem.PemReader.ReadPemObject">
<returns>
A <see cref="T:ThirdParty.BouncyCastle.Utilities.IO.Pem.PemObject"/>
</returns>
<exception cref="T:System.IO.IOException"></exception>
</member>
</members>
</doc>
md5: 1801826BF72C52344F536116E86F4201 | sha1: 3CC8F47F8423C0D98225A5DA4490958041CBFED4 | sha256: 7312B7A3C46F845B5C577BEE0AA65A544F152AD7E3073EF882225BD5E0210B17 | sha512: B501DC4291861EF089EA4A2D86BEA8EF05469BB97CC8CCDCE866FA5CAD7FB4F57781CFFEF9A6CB1F645A9C98224EA9DD39E1CD81CC595B1DFC1E6CF226C41A1C
<?xml version="1.0"?>
<doc>
<assembly>
<name>AWSSDK.Route53</name>
</assembly>
<members>
<member name="T:Amazon.Route53.Internal.AmazonRoute53PostMarshallHandler">
<summary>
Custom pipeline handler
</summary>
</member>
<member name="M:Amazon.Route53.Internal.AmazonRoute53PostMarshallHandler.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
Calls pre invoke logic before calling the next handler
in the pipeline.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="M:Amazon.Route53.Internal.AmazonRoute53PostMarshallHandler.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
Calls pre invoke logic before calling the next handler
in the pipeline.
</summary>
<typeparam name="T">The response type for the current request.</typeparam>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:Amazon.Route53.Internal.AmazonRoute53PostMarshallHandler.PreInvoke(Amazon.Runtime.IExecutionContext)">
<summary>
Custom pipeline handler
</summary>
<param name="executionContext"></param>
</member>
<member name="M:Amazon.Route53.Internal.AmazonRoute53PostMarshallHandler.ProcessRequestHandlers(Amazon.Runtime.IExecutionContext)">
<summary>
Remove duplicates in resource path which can happen if the exact return values from the CreateHostedZone
operation are used.
</summary>
<param name="executionContext">Execution context.</param>
</member>
<member name="T:Amazon.Route53.Internal.AmazonRoute53PreMarshallHandler">
<summary>
Custom pipeline handler
</summary>
</member>
<member name="M:Amazon.Route53.Internal.AmazonRoute53PreMarshallHandler.InvokeSync(Amazon.Runtime.IExecutionContext)">
<summary>
Calls pre invoke logic before calling the next handler
in the pipeline.
</summary>
<param name="executionContext">The execution context which contains both the
requests and response context.</param>
</member>
<member name="M:Amazon.Route53.Internal.AmazonRoute53PreMarshallHandler.InvokeAsync``1(Amazon.Runtime.IExecutionContext)">
<summary>
Calls pre invoke logic before calling the next handler
in the pipeline.
</summary>
<typeparam name="T">The response type for the current request.</typeparam>
<param name="executionContext">The execution context, it contains the
request and response context.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:Amazon.Route53.Internal.AmazonRoute53PreMarshallHandler.PreInvoke(Amazon.Runtime.IExecutionContext)">
<summary>
Custom pipeline handler
</summary>
<param name="executionContext"></param>
</member>
<member name="M:Amazon.Route53.Internal.AmazonRoute53PreMarshallHandler.ProcessRequestHandlers(Amazon.Runtime.IExecutionContext)">
<summary>
Remove prefixes in resource ids.
</summary>
<param name="executionContext">Execution context.</param>
</member>
<member name="T:Amazon.Route53.AmazonRoute53Config">
<summary>
Configuration for accessing Amazon Route53 service
</summary>
</member>
<member name="M:Amazon.Route53.AmazonRoute53Config.#ctor">
<summary>
Default constructor
</summary>
</member>
<member name="P:Amazon.Route53.AmazonRoute53Config.RegionEndpointServiceName">
<summary>
The constant used to lookup in the region hash the endpoint.
</summary>
</member>
<member name="P:Amazon.Route53.AmazonRoute53Config.ServiceVersion">
<summary>
Gets the ServiceVersion property.
</summary>
</member>
<member name="P:Amazon.Route53.AmazonRoute53Config.UserAgent">
<summary>
Gets the value of UserAgent property.
</summary>
</member>
<member name="T:Amazon.Route53.AmazonRoute53Exception">
<summary>
Common exception for the Route53 service.
</summary>
</member>
<member name="M:Amazon.Route53.AmazonRoute53Exception.#ctor(System.String)">
<summary>
Construct instance of AmazonRoute53Exception
</summary>
<param name="message"></param>
</member>
<member name="M:Amazon.Route53.AmazonRoute53Exception.#ctor(System.String,System.Exception)">
<summary>
Construct instance of AmazonRoute53Exception
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.AmazonRoute53Exception.#ctor(System.Exception)">
<summary>
Construct instance of AmazonRoute53Exception
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.AmazonRoute53Exception.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of AmazonRoute53Exception
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.AmazonRoute53Exception.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of AmazonRoute53Exception
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.ChangeAction">
<summary>
Constants used for properties of type ChangeAction.
</summary>
</member>
<member name="F:Amazon.Route53.ChangeAction.CREATE">
<summary>
Constant CREATE for ChangeAction
</summary>
</member>
<member name="F:Amazon.Route53.ChangeAction.DELETE">
<summary>
Constant DELETE for ChangeAction
</summary>
</member>
<member name="F:Amazon.Route53.ChangeAction.UPSERT">
<summary>
Constant UPSERT for ChangeAction
</summary>
</member>
<member name="M:Amazon.Route53.ChangeAction.#ctor(System.String)">
<summary>
This constant constructor does not need to be called if the constant
you are attempting to use is already defined as a static instance of
this class.
This constructor should be used to construct constants that are not
defined as statics, for instance if attempting to use a feature that is
newer than the current version of the SDK.
</summary>
</member>
<member name="M:Amazon.Route53.ChangeAction.FindValue(System.String)">
<summary>
Finds the constant for the unique value.
</summary>
<param name="value">The unique value for the constant</param>
<returns>The constant for the unique value</returns>
</member>
<member name="M:Amazon.Route53.ChangeAction.op_Implicit(System.String)~Amazon.Route53.ChangeAction">
<summary>
Utility method to convert strings to the constant class.
</summary>
<param name="value">The string value to convert to the constant class.</param>
<returns></returns>
</member>
<member name="T:Amazon.Route53.ChangeStatus">
<summary>
Constants used for properties of type ChangeStatus.
</summary>
</member>
<member name="F:Amazon.Route53.ChangeStatus.INSYNC">
<summary>
Constant INSYNC for ChangeStatus
</summary>
</member>
<member name="F:Amazon.Route53.ChangeStatus.PENDING">
<summary>
Constant PENDING for ChangeStatus
</summary>
</member>
<member name="M:Amazon.Route53.ChangeStatus.#ctor(System.String)">
<summary>
This constant constructor does not need to be called if the constant
you are attempting to use is already defined as a static instance of
this class.
This constructor should be used to construct constants that are not
defined as statics, for instance if attempting to use a feature that is
newer than the current version of the SDK.
</summary>
</member>
<member name="M:Amazon.Route53.ChangeStatus.FindValue(System.String)">
<summary>
Finds the constant for the unique value.
</summary>
<param name="value">The unique value for the constant</param>
<returns>The constant for the unique value</returns>
</member>
<member name="M:Amazon.Route53.ChangeStatus.op_Implicit(System.String)~Amazon.Route53.ChangeStatus">
<summary>
Utility method to convert strings to the constant class.
</summary>
<param name="value">The string value to convert to the constant class.</param>
<returns></returns>
</member>
<member name="T:Amazon.Route53.HealthCheckType">
<summary>
Constants used for properties of type HealthCheckType.
</summary>
</member>
<member name="F:Amazon.Route53.HealthCheckType.CALCULATED">
<summary>
Constant CALCULATED for HealthCheckType
</summary>
</member>
<member name="F:Amazon.Route53.HealthCheckType.HTTP">
<summary>
Constant HTTP for HealthCheckType
</summary>
</member>
<member name="F:Amazon.Route53.HealthCheckType.HTTP_STR_MATCH">
<summary>
Constant HTTP_STR_MATCH for HealthCheckType
</summary>
</member>
<member name="F:Amazon.Route53.HealthCheckType.HTTPS">
<summary>
Constant HTTPS for HealthCheckType
</summary>
</member>
<member name="F:Amazon.Route53.HealthCheckType.HTTPS_STR_MATCH">
<summary>
Constant HTTPS_STR_MATCH for HealthCheckType
</summary>
</member>
<member name="F:Amazon.Route53.HealthCheckType.TCP">
<summary>
Constant TCP for HealthCheckType
</summary>
</member>
<member name="M:Amazon.Route53.HealthCheckType.#ctor(System.String)">
<summary>
This constant constructor does not need to be called if the constant
you are attempting to use is already defined as a static instance of
this class.
This constructor should be used to construct constants that are not
defined as statics, for instance if attempting to use a feature that is
newer than the current version of the SDK.
</summary>
</member>
<member name="M:Amazon.Route53.HealthCheckType.FindValue(System.String)">
<summary>
Finds the constant for the unique value.
</summary>
<param name="value">The unique value for the constant</param>
<returns>The constant for the unique value</returns>
</member>
<member name="M:Amazon.Route53.HealthCheckType.op_Implicit(System.String)~Amazon.Route53.HealthCheckType">
<summary>
Utility method to convert strings to the constant class.
</summary>
<param name="value">The string value to convert to the constant class.</param>
<returns></returns>
</member>
<member name="T:Amazon.Route53.ResourceRecordSetFailover">
<summary>
Constants used for properties of type ResourceRecordSetFailover.
</summary>
</member>
<member name="F:Amazon.Route53.ResourceRecordSetFailover.PRIMARY">
<summary>
Constant PRIMARY for ResourceRecordSetFailover
</summary>
</member>
<member name="F:Amazon.Route53.ResourceRecordSetFailover.SECONDARY">
<summary>
Constant SECONDARY for ResourceRecordSetFailover
</summary>
</member>
<member name="M:Amazon.Route53.ResourceRecordSetFailover.#ctor(System.String)">
<summary>
This constant constructor does not need to be called if the constant
you are attempting to use is already defined as a static instance of
this class.
This constructor should be used to construct constants that are not
defined as statics, for instance if attempting to use a feature that is
newer than the current version of the SDK.
</summary>
</member>
<member name="M:Amazon.Route53.ResourceRecordSetFailover.FindValue(System.String)">
<summary>
Finds the constant for the unique value.
</summary>
<param name="value">The unique value for the constant</param>
<returns>The constant for the unique value</returns>
</member>
<member name="M:Amazon.Route53.ResourceRecordSetFailover.op_Implicit(System.String)~Amazon.Route53.ResourceRecordSetFailover">
<summary>
Utility method to convert strings to the constant class.
</summary>
<param name="value">The string value to convert to the constant class.</param>
<returns></returns>
</member>
<member name="T:Amazon.Route53.ResourceRecordSetRegion">
<summary>
Constants used for properties of type ResourceRecordSetRegion.
</summary>
</member>
<member name="F:Amazon.Route53.ResourceRecordSetRegion.ApNortheast1">
<summary>
Constant ApNortheast1 for ResourceRecordSetRegion
</summary>
</member>
<member name="F:Amazon.Route53.ResourceRecordSetRegion.ApSoutheast1">
<summary>
Constant ApSoutheast1 for ResourceRecordSetRegion
</summary>
</member>
<member name="F:Amazon.Route53.ResourceRecordSetRegion.ApSoutheast2">
<summary>
Constant ApSoutheast2 for ResourceRecordSetRegion
</summary>
</member>
<member name="F:Amazon.Route53.ResourceRecordSetRegion.CnNorth1">
<summary>
Constant CnNorth1 for ResourceRecordSetRegion
</summary>
</member>
<member name="F:Amazon.Route53.ResourceRecordSetRegion.EuCentral1">
<summary>
Constant EuCentral1 for ResourceRecordSetRegion
</summary>
</member>
<member name="F:Amazon.Route53.ResourceRecordSetRegion.EuWest1">
<summary>
Constant EuWest1 for ResourceRecordSetRegion
</summary>
</member>
<member name="F:Amazon.Route53.ResourceRecordSetRegion.SaEast1">
<summary>
Constant SaEast1 for ResourceRecordSetRegion
</summary>
</member>
<member name="F:Amazon.Route53.ResourceRecordSetRegion.UsEast1">
<summary>
Constant UsEast1 for ResourceRecordSetRegion
</summary>
</member>
<member name="F:Amazon.Route53.ResourceRecordSetRegion.UsWest1">
<summary>
Constant UsWest1 for ResourceRecordSetRegion
</summary>
</member>
<member name="F:Amazon.Route53.ResourceRecordSetRegion.UsWest2">
<summary>
Constant UsWest2 for ResourceRecordSetRegion
</summary>
</member>
<member name="M:Amazon.Route53.ResourceRecordSetRegion.#ctor(System.String)">
<summary>
This constant constructor does not need to be called if the constant
you are attempting to use is already defined as a static instance of
this class.
This constructor should be used to construct constants that are not
defined as statics, for instance if attempting to use a feature that is
newer than the current version of the SDK.
</summary>
</member>
<member name="M:Amazon.Route53.ResourceRecordSetRegion.FindValue(System.String)">
<summary>
Finds the constant for the unique value.
</summary>
<param name="value">The unique value for the constant</param>
<returns>The constant for the unique value</returns>
</member>
<member name="M:Amazon.Route53.ResourceRecordSetRegion.op_Implicit(System.String)~Amazon.Route53.ResourceRecordSetRegion">
<summary>
Utility method to convert strings to the constant class.
</summary>
<param name="value">The string value to convert to the constant class.</param>
<returns></returns>
</member>
<member name="T:Amazon.Route53.RRType">
<summary>
Constants used for properties of type RRType.
</summary>
</member>
<member name="F:Amazon.Route53.RRType.A">
<summary>
Constant A for RRType
</summary>
</member>
<member name="F:Amazon.Route53.RRType.AAAA">
<summary>
Constant AAAA for RRType
</summary>
</member>
<member name="F:Amazon.Route53.RRType.CNAME">
<summary>
Constant CNAME for RRType
</summary>
</member>
<member name="F:Amazon.Route53.RRType.MX">
<summary>
Constant MX for RRType
</summary>
</member>
<member name="F:Amazon.Route53.RRType.NS">
<summary>
Constant NS for RRType
</summary>
</member>
<member name="F:Amazon.Route53.RRType.PTR">
<summary>
Constant PTR for RRType
</summary>
</member>
<member name="F:Amazon.Route53.RRType.SOA">
<summary>
Constant SOA for RRType
</summary>
</member>
<member name="F:Amazon.Route53.RRType.SPF">
<summary>
Constant SPF for RRType
</summary>
</member>
<member name="F:Amazon.Route53.RRType.SRV">
<summary>
Constant SRV for RRType
</summary>
</member>
<member name="F:Amazon.Route53.RRType.TXT">
<summary>
Constant TXT for RRType
</summary>
</member>
<member name="M:Amazon.Route53.RRType.#ctor(System.String)">
<summary>
This constant constructor does not need to be called if the constant
you are attempting to use is already defined as a static instance of
this class.
This constructor should be used to construct constants that are not
defined as statics, for instance if attempting to use a feature that is
newer than the current version of the SDK.
</summary>
</member>
<member name="M:Amazon.Route53.RRType.FindValue(System.String)">
<summary>
Finds the constant for the unique value.
</summary>
<param name="value">The unique value for the constant</param>
<returns>The constant for the unique value</returns>
</member>
<member name="M:Amazon.Route53.RRType.op_Implicit(System.String)~Amazon.Route53.RRType">
<summary>
Utility method to convert strings to the constant class.
</summary>
<param name="value">The string value to convert to the constant class.</param>
<returns></returns>
</member>
<member name="T:Amazon.Route53.TagResourceType">
<summary>
Constants used for properties of type TagResourceType.
</summary>
</member>
<member name="F:Amazon.Route53.TagResourceType.Healthcheck">
<summary>
Constant Healthcheck for TagResourceType
</summary>
</member>
<member name="F:Amazon.Route53.TagResourceType.Hostedzone">
<summary>
Constant Hostedzone for TagResourceType
</summary>
</member>
<member name="M:Amazon.Route53.TagResourceType.#ctor(System.String)">
<summary>
This constant constructor does not need to be called if the constant
you are attempting to use is already defined as a static instance of
this class.
This constructor should be used to construct constants that are not
defined as statics, for instance if attempting to use a feature that is
newer than the current version of the SDK.
</summary>
</member>
<member name="M:Amazon.Route53.TagResourceType.FindValue(System.String)">
<summary>
Finds the constant for the unique value.
</summary>
<param name="value">The unique value for the constant</param>
<returns>The constant for the unique value</returns>
</member>
<member name="M:Amazon.Route53.TagResourceType.op_Implicit(System.String)~Amazon.Route53.TagResourceType">
<summary>
Utility method to convert strings to the constant class.
</summary>
<param name="value">The string value to convert to the constant class.</param>
<returns></returns>
</member>
<member name="T:Amazon.Route53.VPCRegion">
<summary>
Constants used for properties of type VPCRegion.
</summary>
</member>
<member name="F:Amazon.Route53.VPCRegion.ApNortheast1">
<summary>
Constant ApNortheast1 for VPCRegion
</summary>
</member>
<member name="F:Amazon.Route53.VPCRegion.ApSoutheast1">
<summary>
Constant ApSoutheast1 for VPCRegion
</summary>
</member>
<member name="F:Amazon.Route53.VPCRegion.ApSoutheast2">
<summary>
Constant ApSoutheast2 for VPCRegion
</summary>
</member>
<member name="F:Amazon.Route53.VPCRegion.CnNorth1">
<summary>
Constant CnNorth1 for VPCRegion
</summary>
</member>
<member name="F:Amazon.Route53.VPCRegion.EuCentral1">
<summary>
Constant EuCentral1 for VPCRegion
</summary>
</member>
<member name="F:Amazon.Route53.VPCRegion.EuWest1">
<summary>
Constant EuWest1 for VPCRegion
</summary>
</member>
<member name="F:Amazon.Route53.VPCRegion.SaEast1">
<summary>
Constant SaEast1 for VPCRegion
</summary>
</member>
<member name="F:Amazon.Route53.VPCRegion.UsEast1">
<summary>
Constant UsEast1 for VPCRegion
</summary>
</member>
<member name="F:Amazon.Route53.VPCRegion.UsWest1">
<summary>
Constant UsWest1 for VPCRegion
</summary>
</member>
<member name="F:Amazon.Route53.VPCRegion.UsWest2">
<summary>
Constant UsWest2 for VPCRegion
</summary>
</member>
<member name="M:Amazon.Route53.VPCRegion.#ctor(System.String)">
<summary>
This constant constructor does not need to be called if the constant
you are attempting to use is already defined as a static instance of
this class.
This constructor should be used to construct constants that are not
defined as statics, for instance if attempting to use a feature that is
newer than the current version of the SDK.
</summary>
</member>
<member name="M:Amazon.Route53.VPCRegion.FindValue(System.String)">
<summary>
Finds the constant for the unique value.
</summary>
<param name="value">The unique value for the constant</param>
<returns>The constant for the unique value</returns>
</member>
<member name="M:Amazon.Route53.VPCRegion.op_Implicit(System.String)~Amazon.Route53.VPCRegion">
<summary>
Utility method to convert strings to the constant class.
</summary>
<param name="value">The string value to convert to the constant class.</param>
<returns></returns>
</member>
<member name="T:Amazon.Route53.Model.AliasTarget">
<summary>
<i>Alias resource record sets only:</i> Information about the CloudFront distribution,
ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which
you are routing traffic.
<para>
If you're creating resource record sets for a private hosted zone, note the following:
</para>
<ul> <li>You can create alias resource record sets only for Amazon Route 53 resource
record sets in the same private hosted zone. Creating alias resource record sets for
CloudFront distributions, ELB load balancers, and Amazon S3 buckets is not supported.</li>
<li>You can't create alias resource record sets for failover, geolocation, or latency
resource record sets in a private hosted zone.</li> </ul>
<para>
For more information and an example, see <a href="http://docs.aws.amazon.com/Route53/latest/APIReference/CreateAliasRRSAPI.html">Example:
Creating Alias Resource Record Sets</a> in the <i>Amazon Route 53 API Reference</i>.
</para>
</summary>
</member>
<member name="M:Amazon.Route53.Model.AliasTarget.#ctor">
<summary>
Empty constructor used to set properties independently even when a simple constructor is available
</summary>
</member>
<member name="M:Amazon.Route53.Model.AliasTarget.#ctor(System.String,System.String)">
<summary>
Instantiates AliasTarget with the parameterized properties
</summary>
<param name="hostedZoneId"><i>Alias resource record sets only:</i> The value you use depends on where you want to route queries: <ul> <li><b>A CloudFront distribution:</b> Specify <code>Z2FDTNDATAQYW2</code>.</li> <li>An ELB load balancer: Specify the value of the hosted zone ID for the load balancer. You can get the hosted zone ID by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for <code>HostedZoneId</code> and <code>DNSName</code>. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail.</li> <li><b>An Amazon S3 bucket that is configured as a static website:</b> Specify the hosted zone ID for the Amazon S3 website endpoint in which you created the bucket. For more information about valid values, see the table <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Amazon Simple Storage Service (S3) Website Endpoints</a> in the <i>Amazon Web Services General Reference</i>.</li> <li><b>Another Amazon Route 53 resource record set in your hosted zone:</b> Specify the hosted zone ID of your hosted zone. (An alias resource record set cannot reference a resource record set in a different hosted zone.)</li> </ul> For more information and an example, see <a href="http://docs.aws.amazon.com/Route53/latest/APIReference/CreateAliasRRSAPI.html">Example: Creating Alias Resource Record Sets</a> in the <i>Amazon Route 53 API Reference</i>.</param>
<param name="dnsName"><i>Alias resource record sets only:</i> The external DNS name associated with the AWS Resource. The value that you specify depends on where you want to route queries: <ul> <li><b>A CloudFront distribution:</b> Specify the domain name that CloudFront assigned when you created your distribution. Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is <code>acme.example.com</code>, your CloudFront distribution must include <code>acme.example.com</code> as one of the alternate domain names. For more information, see <a href="http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html">Using Alternate Domain Names (CNAMEs)</a> in the <i>Amazon CloudFront Developer Guide</i>.</li> <li><b>An ELB load balancer:</b> Specify the DNS name associated with the load balancer. You can get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for <code>HostedZoneId</code> and <code>DNSName</code>. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail.</li> <li><b>An Amazon S3 bucket that is configured as a static website:</b> Specify the domain name of the Amazon S3 website endpoint in which you created the bucket; for example, <code>s3-website-us-east-1.amazonaws.com</code>. For more information about valid values, see the table <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Amazon Simple Storage Service (S3) Website Endpoints</a> in the <i>Amazon Web Services General Reference</i>. For more information about using Amazon S3 buckets for websites, see <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting a Static Website on Amazon S3</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</li> <li/> </ul> For more information and an example, see <a href="http://docs.aws.amazon.com/Route53/latest/APIReference/CreateAliasRRSAPI.html">Example: Creating Alias Resource Record Sets</a> in the <i>Amazon Route 53 API Reference</i>.</param>
</member>
<member name="P:Amazon.Route53.Model.AliasTarget.HostedZoneId">
<summary>
Gets and sets the property HostedZoneId.
<para>
<i>Alias resource record sets only:</i> The value you use depends on where you want
to route queries:
</para>
<ul> <li><b>A CloudFront distribution:</b> Specify <code>Z2FDTNDATAQYW2</code>.</li>
<li>An ELB load balancer: Specify the value of the hosted zone ID for the load balancer.
You can get the hosted zone ID by using the AWS Management Console, the ELB API, or
the AWS CLI. Use the same method to get values for <code>HostedZoneId</code> and <code>DNSName</code>.
If you get one value from the console and the other value from the API or the CLI,
creating the resource record set will fail.</li> <li><b>An Amazon S3 bucket that is
configured as a static website:</b> Specify the hosted zone ID for the Amazon S3 website
endpoint in which you created the bucket. For more information about valid values,
see the table <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Amazon
Simple Storage Service (S3) Website Endpoints</a> in the <i>Amazon Web Services General
Reference</i>.</li> <li><b>Another Amazon Route 53 resource record set in your hosted
zone:</b> Specify the hosted zone ID of your hosted zone. (An alias resource record
set cannot reference a resource record set in a different hosted zone.)</li> </ul>
<para>
For more information and an example, see <a href="http://docs.aws.amazon.com/Route53/latest/APIReference/CreateAliasRRSAPI.html">Example:
Creating Alias Resource Record Sets</a> in the <i>Amazon Route 53 API Reference</i>.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.AliasTarget.DNSName">
<summary>
Gets and sets the property DNSName.
<para>
<i>Alias resource record sets only:</i> The external DNS name associated with the
AWS Resource. The value that you specify depends on where you want to route queries:
</para>
<ul> <li><b>A CloudFront distribution:</b> Specify the domain name that CloudFront
assigned when you created your distribution. Your CloudFront distribution must include
an alternate domain name that matches the name of the resource record set. For example,
if the name of the resource record set is <code>acme.example.com</code>, your CloudFront
distribution must include <code>acme.example.com</code> as one of the alternate domain
names. For more information, see <a href="http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html">Using
Alternate Domain Names (CNAMEs)</a> in the <i>Amazon CloudFront Developer Guide</i>.</li>
<li><b>An ELB load balancer:</b> Specify the DNS name associated with the load balancer.
You can get the DNS name by using the AWS Management Console, the ELB API, or the
AWS CLI. Use the same method to get values for <code>HostedZoneId</code> and <code>DNSName</code>.
If you get one value from the console and the other value from the API or the CLI,
creating the resource record set will fail.</li> <li><b>An Amazon S3 bucket that is
configured as a static website:</b> Specify the domain name of the Amazon S3 website
endpoint in which you created the bucket; for example, <code>s3-website-us-east-1.amazonaws.com</code>.
For more information about valid values, see the table <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Amazon
Simple Storage Service (S3) Website Endpoints</a> in the <i>Amazon Web Services General
Reference</i>. For more information about using Amazon S3 buckets for websites, see
<a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting
a Static Website on Amazon S3</a> in the <i>Amazon Simple Storage Service Developer
Guide</i>.</li> <li/> </ul>
<para>
For more information and an example, see <a href="http://docs.aws.amazon.com/Route53/latest/APIReference/CreateAliasRRSAPI.html">Example:
Creating Alias Resource Record Sets</a> in the <i>Amazon Route 53 API Reference</i>.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.AliasTarget.EvaluateTargetHealth">
<summary>
Gets and sets the property EvaluateTargetHealth.
<para>
<i>Alias resource record sets only:</i> If you set the value of <code>EvaluateTargetHealth</code>
to <code>true</code> for the resource record set or sets in an alias, weighted alias,
latency alias, or failover alias resource record set, and if you specify a value for
<code>HealthCheckId</code> for every resource record set that is referenced by these
alias resource record sets, the alias resource record sets inherit the health of the
referenced resource record sets.
</para>
<para>
In this configuration, when Amazon Route 53 receives a DNS query for an alias resource
record set:
</para>
<ol> <li>Amazon Route 53 looks at the resource record sets that are referenced by
the alias resource record sets to determine which health checks they're using.</li>
<li>Amazon Route 53 checks the current status of each health check. (Amazon Route
53 periodically checks the health of the endpoint that is specified in a health check;
it doesn't perform the health check when the DNS query arrives.)</li> <li>Based on
the status of the health checks, Amazon Route 53 determines which resource record
sets are healthy. Unhealthy resource record sets are immediately removed from consideration.
In addition, if all of the resource record sets that are referenced by an alias resource
record set are unhealthy, that alias resource record set also is immediately removed
from consideration.</li> <li>Based on the configuration of the alias resource record
sets (weighted alias or latency alias, for example) and the configuration of the resource
record sets that they reference, Amazon Route 53 chooses a resource record set from
the healthy resource record sets, and responds to the query.</li> </ol>
<para>
Note the following:
</para>
<ul><li>You cannot set EvaluateTargetHealth to true when the alias target is a CloudFront
distribution.</li> <li>If the AWS resource that you specify in <code>AliasTarget</code>
is a resource record set or a group of resource record sets (for example, a group
of weighted resource record sets), but it is not another alias resource record set,
we recommend that you associate a health check with all of the resource record sets
in the alias target. For more information, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting">What
Happens When You Omit Health Checks?</a> in the <i>Amazon Route 53 Developer Guide</i>.</li>
<li>If you specify an ELB load balancer in <code>AliasTarget</code>, Elastic Load
Balancing routes queries only to the healthy Amazon EC2 instances that are registered
with the load balancer. If no Amazon EC2 instances are healthy or if the load balancer
itself is unhealthy, and if <code>EvaluateTargetHealth</code> is <code>true</code>
for the corresponding alias resource record set, Amazon Route 53 routes queries to
other resources.</li> <li>When you create a load balancer, you configure settings
for Elastic Load Balancing health checks; they're not Amazon Route 53 health checks,
but they perform a similar function. Do not create Amazon Route 53 health checks for
the Amazon EC2 instances that you register with an ELB load balancer. For more information,
see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html">How
Health Checks Work in More Complex Amazon Route 53 Configurations</a> in the <i>Amazon
Route 53 Developer Guide</i>.</li> </ul>
<para>
We recommend that you set <code>EvaluateTargetHealth</code> to <code>true</code> only
when you have enough idle capacity to handle the failure of one or more endpoints.
</para>
<para>
For more information and examples, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html">Amazon
Route 53 Health Checks and DNS Failover</a> in the <i>Amazon Route 53 Developer Guide</i>.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.AssociateVPCWithHostedZoneRequest">
<summary>
Container for the parameters to the AssociateVPCWithHostedZone operation.
This action associates a VPC with an hosted zone.
<para>
To associate a VPC with an hosted zone, send a <code>POST</code> request to the <code>2013-04-01/hostedzone/<i>hosted
zone ID</i>/associatevpc</code> resource. The request body must include an XML document
with a <code>AssociateVPCWithHostedZoneRequest</code> element. The response returns
the <code>AssociateVPCWithHostedZoneResponse</code> element that contains <code>ChangeInfo</code>
for you to track the progress of the <code>AssociateVPCWithHostedZoneRequest</code>
you made. See <code>GetChange</code> operation for how to track the progress of your
change.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.AssociateVPCWithHostedZoneRequest.HostedZoneId">
<summary>
Gets and sets the property HostedZoneId.
<para>
The ID of the hosted zone you want to associate your VPC with.
</para>
<para>
Note that you cannot associate a VPC with a hosted zone that doesn't have an existing
VPC association.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.AssociateVPCWithHostedZoneRequest.VPC">
<summary>
Gets and sets the property VPC.
<para>
The VPC that you want your hosted zone to be associated with.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.AssociateVPCWithHostedZoneRequest.Comment">
<summary>
Gets and sets the property Comment.
<para>
<i>Optional:</i> Any comments you want to include about a <code>AssociateVPCWithHostedZoneRequest</code>.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.AssociateVPCWithHostedZoneResponse">
<summary>
A complex type containing the response information for the request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.AssociateVPCWithHostedZoneResponse.ChangeInfo">
<summary>
Gets and sets the property ChangeInfo.
<para>
A complex type that contains the ID, the status, and the date and time of your <code>AssociateVPCWithHostedZoneRequest</code>.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.Change">
<summary>
A complex type that contains the information for each change in a change batch request.
</summary>
</member>
<member name="M:Amazon.Route53.Model.Change.#ctor">
<summary>
Empty constructor used to set properties independently even when a simple constructor is available
</summary>
</member>
<member name="M:Amazon.Route53.Model.Change.#ctor(Amazon.Route53.ChangeAction,Amazon.Route53.Model.ResourceRecordSet)">
<summary>
Instantiates Change with the parameterized properties
</summary>
<param name="action">The action to perform: <ul> <li><code>CREATE</code>: Creates a resource record set that has the specified values.</li> <li><CODE>DELETE</CODE>: Deletes a existing resource record set that has the specified values for <code>Name</code>, <code>Type</code>, <code>SetIdentifier</code> (for latency, weighted, geolocation, and failover resource record sets), and <code>TTL</code> (except alias resource record sets, for which the TTL is determined by the AWS resource that you're routing DNS queries to).</li> <li><code>UPSERT</code>: If a resource record set does not already exist, Amazon Route 53 creates it. If a resource record set does exist, Amazon Route 53 updates it with the values in the request. Amazon Route 53 can update an existing resource record set only when all of the following values match: <code>Name</code>, <code>Type</code>, and <code>SetIdentifier</code> (for weighted, latency, geolocation, and failover resource record sets).</li> </ul></param>
<param name="resourceRecordSet">Information about the resource record set to create or delete.</param>
</member>
<member name="P:Amazon.Route53.Model.Change.Action">
<summary>
Gets and sets the property Action.
<para>
The action to perform:
</para>
<ul> <li><code>CREATE</code>: Creates a resource record set that has the specified
values.</li> <li><CODE>DELETE</CODE>: Deletes a existing resource record set that
has the specified values for <code>Name</code>, <code>Type</code>, <code>SetIdentifier</code>
(for latency, weighted, geolocation, and failover resource record sets), and <code>TTL</code>
(except alias resource record sets, for which the TTL is determined by the AWS resource
that you're routing DNS queries to).</li> <li><code>UPSERT</code>: If a resource record
set does not already exist, Amazon Route 53 creates it. If a resource record set does
exist, Amazon Route 53 updates it with the values in the request. Amazon Route 53
can update an existing resource record set only when all of the following values match:
<code>Name</code>, <code>Type</code>, and <code>SetIdentifier</code> (for weighted,
latency, geolocation, and failover resource record sets).</li> </ul>
</summary>
</member>
<member name="P:Amazon.Route53.Model.Change.ResourceRecordSet">
<summary>
Gets and sets the property ResourceRecordSet.
<para>
Information about the resource record set to create or delete.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ChangeBatch">
<summary>
A complex type that contains an optional comment and the changes that you want to
make with a change batch request.
</summary>
</member>
<member name="M:Amazon.Route53.Model.ChangeBatch.#ctor">
<summary>
Empty constructor used to set properties independently even when a simple constructor is available
</summary>
</member>
<member name="M:Amazon.Route53.Model.ChangeBatch.#ctor(System.Collections.Generic.List{Amazon.Route53.Model.Change})">
<summary>
Instantiates ChangeBatch with the parameterized properties
</summary>
<param name="changes">A complex type that contains one <code>Change</code> element for each resource record set that you want to create or delete.</param>
</member>
<member name="P:Amazon.Route53.Model.ChangeBatch.Comment">
<summary>
Gets and sets the property Comment.
<para>
<i>Optional:</i> Any comments you want to include about a change batch request.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeBatch.Changes">
<summary>
Gets and sets the property Changes.
<para>
A complex type that contains one <code>Change</code> element for each resource record
set that you want to create or delete.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ChangeBatchRecord">
<summary>
A complex type that lists the changes and information for a ChangeBatch.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeBatchRecord.Id">
<summary>
Gets and sets the property Id.
<para>
The ID of the request. Use this ID to track when the change has completed across all
Amazon Route 53 DNS servers.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeBatchRecord.SubmittedAt">
<summary>
Gets and sets the property SubmittedAt.
<para>
The date and time the change was submitted, in the format <code>YYYY-MM-DDThh:mm:ssZ</code>,
as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The <code>Z</code>
after the time indicates that the time is listed in Coordinated Universal Time (UTC).
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeBatchRecord.Status">
<summary>
Gets and sets the property Status.
<para>
The current state of the request. <code>PENDING</code> indicates that this request
has not yet been applied to all Amazon Route 53 DNS servers.
</para>
<para>
Valid Values: <code>PENDING</code> | <code>INSYNC</code>
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeBatchRecord.Comment">
<summary>
Gets and sets the property Comment.
<para>
A complex type that describes change information about changes made to your hosted
zone.
</para>
<para>
This element contains an ID that you use when performing a <a>GetChange</a> action
to get detailed information about the change.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeBatchRecord.Submitter">
<summary>
Gets and sets the property Submitter.
<para>
The AWS account ID attached to the changes.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeBatchRecord.Changes">
<summary>
Gets and sets the property Changes.
<para>
A list of changes made in the ChangeBatch.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ChangeInfo">
<summary>
A complex type that describes change information about changes made to your hosted
zone.
<para>
This element contains an ID that you use when performing a <a>GetChange</a> action
to get detailed information about the change.
</para>
</summary>
</member>
<member name="M:Amazon.Route53.Model.ChangeInfo.#ctor">
<summary>
Empty constructor used to set properties independently even when a simple constructor is available
</summary>
</member>
<member name="M:Amazon.Route53.Model.ChangeInfo.#ctor(System.String,Amazon.Route53.ChangeStatus,System.DateTime)">
<summary>
Instantiates ChangeInfo with the parameterized properties
</summary>
<param name="id">The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.</param>
<param name="status">The current state of the request. <code>PENDING</code> indicates that this request has not yet been applied to all Amazon Route 53 DNS servers. Valid Values: <code>PENDING</code> | <code>INSYNC</code></param>
<param name="submittedAt">The date and time the change was submitted, in the format <code>YYYY-MM-DDThh:mm:ssZ</code>, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The <code>Z</code> after the time indicates that the time is listed in Coordinated Universal Time (UTC).</param>
</member>
<member name="P:Amazon.Route53.Model.ChangeInfo.Id">
<summary>
Gets and sets the property Id.
<para>
The ID of the request. Use this ID to track when the change has completed across all
Amazon Route 53 DNS servers.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeInfo.Status">
<summary>
Gets and sets the property Status.
<para>
The current state of the request. <code>PENDING</code> indicates that this request
has not yet been applied to all Amazon Route 53 DNS servers.
</para>
<para>
Valid Values: <code>PENDING</code> | <code>INSYNC</code>
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeInfo.SubmittedAt">
<summary>
Gets and sets the property SubmittedAt.
<para>
The date and time the change was submitted, in the format <code>YYYY-MM-DDThh:mm:ssZ</code>,
as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The <code>Z</code>
after the time indicates that the time is listed in Coordinated Universal Time (UTC).
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeInfo.Comment">
<summary>
Gets and sets the property Comment.
<para>
A complex type that describes change information about changes made to your hosted
zone.
</para>
<para>
This element contains an ID that you use when performing a <a>GetChange</a> action
to get detailed information about the change.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ChangeResourceRecordSetsRequest">
<summary>
Container for the parameters to the ChangeResourceRecordSets operation.
Use this action to create or change your authoritative DNS information. To use this
action, send a <code>POST</code> request to the <code>2013-04-01/hostedzone/<i>hosted
Zone ID</i>/rrset</code> resource. The request body must include an XML document with
a <code>ChangeResourceRecordSetsRequest</code> element.
<para>
Changes are a list of change items and are considered transactional. For more information
on transactional changes, also known as change batches, see <a href="http://docs.aws.amazon.com/Route53/latest/APIReference/">POST
ChangeResourceRecordSets</a> in the <i>Amazon Route 53 API Reference</i>.
</para>
<important>Due to the nature of transactional changes, you cannot delete the same
resource record set more than once in a single change batch. If you attempt to delete
the same change batch more than once, Amazon Route 53 returns an <code>InvalidChangeBatch</code>
error.</important>
<para>
In response to a <code>ChangeResourceRecordSets</code> request, your DNS data is changed
on all Amazon Route 53 DNS servers. Initially, the status of a change is <code>PENDING</code>.
This means the change has not yet propagated to all the authoritative Amazon Route
53 DNS servers. When the change is propagated to all hosts, the change returns a status
of <code>INSYNC</code>.
</para>
<para>
Note the following limitations on a <code>ChangeResourceRecordSets</code> request:
</para>
<ul> <li>A request cannot contain more than 100 Change elements.</li> <li> A request
cannot contain more than 1000 ResourceRecord elements.</li> <li>The sum of the number
of characters (including spaces) in all <code>Value</code> elements in a request cannot
exceed 32,000 characters.</li> </ul>
</summary>
</member>
<member name="M:Amazon.Route53.Model.ChangeResourceRecordSetsRequest.#ctor">
<summary>
Empty constructor used to set properties independently even when a simple constructor is available
</summary>
</member>
<member name="M:Amazon.Route53.Model.ChangeResourceRecordSetsRequest.#ctor(System.String,Amazon.Route53.Model.ChangeBatch)">
<summary>
Instantiates ChangeResourceRecordSetsRequest with the parameterized properties
</summary>
<param name="hostedZoneId">The ID of the hosted zone that contains the resource record sets that you want to change.</param>
<param name="changeBatch">A complex type that contains an optional comment and the <code>Changes</code> element.</param>
</member>
<member name="P:Amazon.Route53.Model.ChangeResourceRecordSetsRequest.HostedZoneId">
<summary>
Gets and sets the property HostedZoneId.
<para>
The ID of the hosted zone that contains the resource record sets that you want to
change.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeResourceRecordSetsRequest.ChangeBatch">
<summary>
Gets and sets the property ChangeBatch.
<para>
A complex type that contains an optional comment and the <code>Changes</code> element.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ChangeResourceRecordSetsResponse">
<summary>
A complex type containing the response for the request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeResourceRecordSetsResponse.ChangeInfo">
<summary>
Gets and sets the property ChangeInfo.
<para>
A complex type that contains information about changes made to your hosted zone.
</para>
<para>
This element contains an ID that you use when performing a <a>GetChange</a> action
to get detailed information about the change.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ChangeTagsForResourceRequest">
<summary>
Container for the parameters to the ChangeTagsForResource operation.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeTagsForResourceRequest.ResourceType">
<summary>
Gets and sets the property ResourceType.
<para>
The type of the resource.
</para>
<para>
- The resource type for health checks is <code>healthcheck</code>.
</para>
<para>
- The resource type for hosted zones is <code>hostedzone</code>.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeTagsForResourceRequest.ResourceId">
<summary>
Gets and sets the property ResourceId.
<para>
The ID of the resource for which you want to add, change, or delete tags.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeTagsForResourceRequest.AddTags">
<summary>
Gets and sets the property AddTags.
<para>
A complex type that contains a list of <code>Tag</code> elements. Each <code>Tag</code>
element identifies a tag that you want to add or update for the specified resource.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ChangeTagsForResourceRequest.RemoveTagKeys">
<summary>
Gets and sets the property RemoveTagKeys.
<para>
A list of <code>Tag</code> keys that you want to remove from the specified resource.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ChangeTagsForResourceResponse">
<summary>
Empty response for the request.
</summary>
</member>
<member name="T:Amazon.Route53.Model.ConcurrentModificationException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.ConcurrentModificationException.#ctor(System.String)">
<summary>
Constructs a new ConcurrentModificationException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.ConcurrentModificationException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of ConcurrentModificationException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.ConcurrentModificationException.#ctor(System.Exception)">
<summary>
Construct instance of ConcurrentModificationException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.ConcurrentModificationException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of ConcurrentModificationException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.ConcurrentModificationException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of ConcurrentModificationException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.ConflictingDomainExistsException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.ConflictingDomainExistsException.#ctor(System.String)">
<summary>
Constructs a new ConflictingDomainExistsException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.ConflictingDomainExistsException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of ConflictingDomainExistsException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.ConflictingDomainExistsException.#ctor(System.Exception)">
<summary>
Construct instance of ConflictingDomainExistsException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.ConflictingDomainExistsException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of ConflictingDomainExistsException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.ConflictingDomainExistsException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of ConflictingDomainExistsException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.ConflictingTypesException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.ConflictingTypesException.#ctor(System.String)">
<summary>
Constructs a new ConflictingTypesException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.ConflictingTypesException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of ConflictingTypesException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.ConflictingTypesException.#ctor(System.Exception)">
<summary>
Construct instance of ConflictingTypesException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.ConflictingTypesException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of ConflictingTypesException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.ConflictingTypesException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of ConflictingTypesException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.CreateHealthCheckRequest">
<summary>
Container for the parameters to the CreateHealthCheck operation.
This action creates a new health check.
<para>
To create a new health check, send a <code>POST</code> request to the <code>2013-04-01/healthcheck</code>
resource. The request body must include an XML document with a <code>CreateHealthCheckRequest</code>
element. The response returns the <code>CreateHealthCheckResponse</code> element that
contains metadata about the health check.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateHealthCheckRequest.CallerReference">
<summary>
Gets and sets the property CallerReference.
<para>
A unique string that identifies the request and that allows failed <code>CreateHealthCheck</code>
requests to be retried without the risk of executing the operation twice. You must
use a unique <code>CallerReference</code> string every time you create a health check.
<code>CallerReference</code> can be any unique string; you might choose to use a string
that identifies your project.
</para>
<para>
Valid characters are any Unicode code points that are legal in an XML 1.0 document.
The UTF-8 encoding of the value must be less than 128 bytes.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateHealthCheckRequest.HealthCheckConfig">
<summary>
Gets and sets the property HealthCheckConfig.
<para>
A complex type that contains health check configuration.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.CreateHealthCheckResponse">
<summary>
A complex type containing the response information for the new health check.
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateHealthCheckResponse.HealthCheck">
<summary>
Gets and sets the property HealthCheck.
<para>
A complex type that contains identifying information about the health check.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateHealthCheckResponse.Location">
<summary>
Gets and sets the property Location.
<para>
The unique URL representing the new health check.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.CreateHostedZoneRequest">
<summary>
Container for the parameters to the CreateHostedZone operation.
This action creates a new hosted zone.
<para>
To create a new hosted zone, send a <code>POST</code> request to the <code>2013-04-01/hostedzone</code>
resource. The request body must include an XML document with a <code>CreateHostedZoneRequest</code>
element. The response returns the <code>CreateHostedZoneResponse</code> element that
contains metadata about the hosted zone.
</para>
<para>
Amazon Route 53 automatically creates a default SOA record and four NS records for
the zone. The NS records in the hosted zone are the name servers you give your registrar
to delegate your domain to. For more information about SOA and NS records, see <a
href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/SOA-NSrecords.html">NS
and SOA Records that Amazon Route 53 Creates for a Hosted Zone</a> in the <i>Amazon
Route 53 Developer Guide</i>.
</para>
<para>
When you create a zone, its initial status is <code>PENDING</code>. This means that
it is not yet available on all DNS servers. The status of the zone changes to <code>INSYNC</code>
when the NS and SOA records are available on all Amazon Route 53 DNS servers.
</para>
<para>
When trying to create a hosted zone using a reusable delegation set, you could specify
an optional DelegationSetId, and Route53 would assign those 4 NS records for the zone,
instead of alloting a new one.
</para>
</summary>
</member>
<member name="M:Amazon.Route53.Model.CreateHostedZoneRequest.#ctor">
<summary>
Empty constructor used to set properties independently even when a simple constructor is available
</summary>
</member>
<member name="M:Amazon.Route53.Model.CreateHostedZoneRequest.#ctor(System.String,System.String)">
<summary>
Instantiates CreateHostedZoneRequest with the parameterized properties
</summary>
<param name="name">The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical. This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of <code>NameServers</code> elements returned in <code>DelegationSet</code>.</param>
<param name="callerReference">A unique string that identifies the request and that allows failed <code>CreateHostedZone</code> requests to be retried without the risk of executing the operation twice. You must use a unique <code>CallerReference</code> string every time you create a hosted zone. <code>CallerReference</code> can be any unique string; you might choose to use a string that identifies your project, such as <code>DNSMigration_01</code>. Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.</param>
</member>
<member name="P:Amazon.Route53.Model.CreateHostedZoneRequest.Name">
<summary>
Gets and sets the property Name.
<para>
The name of the domain. This must be a fully-specified domain, for example, www.example.com.
The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully
qualified. This means that Amazon Route 53 treats www.example.com (without a trailing
dot) and www.example.com. (with a trailing dot) as identical.
</para>
<para>
This is the name you have registered with your DNS registrar. You should ask your
registrar to change the authoritative name servers for your domain to the set of <code>NameServers</code>
elements returned in <code>DelegationSet</code>.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateHostedZoneRequest.VPC">
<summary>
Gets and sets the property VPC.
<para>
The VPC that you want your hosted zone to be associated with. By providing this parameter,
your newly created hosted cannot be resolved anywhere other than the given VPC.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateHostedZoneRequest.CallerReference">
<summary>
Gets and sets the property CallerReference.
<para>
A unique string that identifies the request and that allows failed <code>CreateHostedZone</code>
requests to be retried without the risk of executing the operation twice. You must
use a unique <code>CallerReference</code> string every time you create a hosted zone.
<code>CallerReference</code> can be any unique string; you might choose to use a string
that identifies your project, such as <code>DNSMigration_01</code>.
</para>
<para>
Valid characters are any Unicode code points that are legal in an XML 1.0 document.
The UTF-8 encoding of the value must be less than 128 bytes.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateHostedZoneRequest.HostedZoneConfig">
<summary>
Gets and sets the property HostedZoneConfig.
<para>
A complex type that contains an optional comment about your hosted zone.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateHostedZoneRequest.DelegationSetId">
<summary>
Gets and sets the property DelegationSetId.
<para>
The delegation set id of the reusable delgation set whose NS records you want to assign
to the new hosted zone.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.CreateHostedZoneResponse">
<summary>
A complex type containing the response information for the new hosted zone.
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateHostedZoneResponse.HostedZone">
<summary>
Gets and sets the property HostedZone.
<para>
A complex type that contains identifying information about the hosted zone.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateHostedZoneResponse.ChangeInfo">
<summary>
Gets and sets the property ChangeInfo.
<para>
A complex type that contains information about the request to create a hosted zone.
This includes an ID that you use when you call the <a>GetChange</a> action to get
the current status of the change request.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateHostedZoneResponse.DelegationSet">
<summary>
Gets and sets the property DelegationSet.
<para>
A complex type that contains name server information.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateHostedZoneResponse.VPC">
<summary>
Gets and sets the property VPC.
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateHostedZoneResponse.Location">
<summary>
Gets and sets the property Location.
<para>
The unique URL representing the new hosted zone.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.CreateReusableDelegationSetRequest">
<summary>
Container for the parameters to the CreateReusableDelegationSet operation.
This action creates a reusable delegationSet.
<para>
To create a new reusable delegationSet, send a <code>POST</code> request to the <code>2013-04-01/delegationset</code>
resource. The request body must include an XML document with a <code>CreateReusableDelegationSetRequest</code>
element. The response returns the <code>CreateReusableDelegationSetResponse</code>
element that contains metadata about the delegationSet.
</para>
<para>
If the optional parameter HostedZoneId is specified, it marks the delegationSet associated
with that particular hosted zone as reusable.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateReusableDelegationSetRequest.CallerReference">
<summary>
Gets and sets the property CallerReference.
<para>
A unique string that identifies the request and that allows failed <code>CreateReusableDelegationSet</code>
requests to be retried without the risk of executing the operation twice. You must
use a unique <code>CallerReference</code> string every time you create a reusable
delegation set. <code>CallerReference</code> can be any unique string; you might choose
to use a string that identifies your project, such as <code>DNSMigration_01</code>.
</para>
<para>
Valid characters are any Unicode code points that are legal in an XML 1.0 document.
The UTF-8 encoding of the value must be less than 128 bytes.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateReusableDelegationSetRequest.HostedZoneId">
<summary>
Gets and sets the property HostedZoneId.
<para>
The ID of the hosted zone whose delegation set you want to mark as reusable. It is
an optional parameter.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.CreateReusableDelegationSetResponse">
<summary>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateReusableDelegationSetResponse.DelegationSet">
<summary>
Gets and sets the property DelegationSet.
<para>
A complex type that contains name server information.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateReusableDelegationSetResponse.Location">
<summary>
Gets and sets the property Location.
<para>
The unique URL representing the new reusbale delegation set.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.CreateTrafficPolicyInstanceRequest">
<summary>
Container for the parameters to the CreateTrafficPolicyInstance operation.
Creates resource record sets in a specified hosted zone based on the settings in a
specified traffic policy version. In addition, <code>CreateTrafficPolicyInstance</code>
associates the resource record sets with a specified domain name (such as example.com)
or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries
for the domain or subdomain name by using the resource record sets that <code>CreateTrafficPolicyInstance</code>
created.
<para>
To create a traffic policy instance, send a <code>POST</code> request to the <code>2013-04-01/trafficpolicyinstance</code>
resource. The request body must include an XML document with a <code>CreateTrafficPolicyRequest</code>
element. The response returns the <code>CreateTrafficPolicyInstanceResponse</code>
element, which contains information about the traffic policy instance.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyInstanceRequest.HostedZoneId">
<summary>
Gets and sets the property HostedZoneId.
<para>
The ID of the hosted zone in which you want Amazon Route 53 to create resource record
sets by using the configuration in a traffic policy.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyInstanceRequest.Name">
<summary>
Gets and sets the property Name.
<para>
The domain name (such as example.com) or subdomain name (such as www.example.com)
for which Amazon Route 53 responds to DNS queries by using the resource record sets
that Amazon Route 53 creates for this traffic policy instance.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyInstanceRequest.TTL">
<summary>
Gets and sets the property TTL.
<para>
The TTL that you want Amazon Route 53 to assign to all of the resource record sets
that it creates in the specified hosted zone.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyInstanceRequest.TrafficPolicyId">
<summary>
Gets and sets the property TrafficPolicyId.
<para>
The ID of the traffic policy that you want to use to create resource record sets in
the specified hosted zone.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyInstanceRequest.TrafficPolicyVersion">
<summary>
Gets and sets the property TrafficPolicyVersion.
<para>
The version of the traffic policy that you want to use to create resource record sets
in the specified hosted zone.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.CreateTrafficPolicyInstanceResponse">
<summary>
A complex type that contains the response information for the <code>CreateTrafficPolicyInstance</code>
request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyInstanceResponse.TrafficPolicyInstance">
<summary>
Gets and sets the property TrafficPolicyInstance.
<para>
A complex type that contains settings for the new traffic policy instance.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyInstanceResponse.Location">
<summary>
Gets and sets the property Location.
<para>
A unique URL that represents a new traffic policy instance.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.CreateTrafficPolicyRequest">
<summary>
Container for the parameters to the CreateTrafficPolicy operation.
Creates a traffic policy, which you use to create multiple DNS resource record sets
for one domain name (such as example.com) or one subdomain name (such as www.example.com).
<para>
To create a traffic policy, send a <code>POST</code> request to the <code>2013-04-01/trafficpolicy</code>
resource. The request body must include an XML document with a <code>CreateTrafficPolicyRequest</code>
element. The response includes the <code>CreateTrafficPolicyResponse</code> element,
which contains information about the new traffic policy.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyRequest.Name">
<summary>
Gets and sets the property Name.
<para>
The name of the traffic policy.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyRequest.Document">
<summary>
Gets and sets the property Document.
<para>
The definition of this traffic policy in JSON format.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyRequest.Comment">
<summary>
Gets and sets the property Comment.
<para>
Any comments that you want to include about the traffic policy.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.CreateTrafficPolicyResponse">
<summary>
A complex type that contains the response information for the <code>CreateTrafficPolicy</code>
request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyResponse.TrafficPolicy">
<summary>
Gets and sets the property TrafficPolicy.
<para>
A complex type that contains settings for the new traffic policy.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyResponse.Location">
<summary>
Gets and sets the property Location.
</summary>
</member>
<member name="T:Amazon.Route53.Model.CreateTrafficPolicyVersionRequest">
<summary>
Container for the parameters to the CreateTrafficPolicyVersion operation.
Creates a new version of an existing traffic policy. When you create a new version
of a traffic policy, you specify the ID of the traffic policy that you want to update
and a JSON-formatted document that describes the new version.
<para>
You use traffic policies to create multiple DNS resource record sets for one domain
name (such as example.com) or one subdomain name (such as www.example.com).
</para>
<para>
To create a new version, send a <code>POST</code> request to the <code>2013-04-01/trafficpolicy/</code>
resource. The request body includes an XML document with a <code>CreateTrafficPolicyVersionRequest</code>
element. The response returns the <code>CreateTrafficPolicyVersionResponse</code>
element, which contains information about the new version of the traffic policy.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyVersionRequest.Id">
<summary>
Gets and sets the property Id.
<para>
The ID of the traffic policy for which you want to create a new version.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyVersionRequest.Document">
<summary>
Gets and sets the property Document.
<para>
The definition of a new traffic policy version, in JSON format. You must specify the
full definition of the new traffic policy. You cannot specify just the differences
between the new version and a previous version.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyVersionRequest.Comment">
<summary>
Gets and sets the property Comment.
<para>
Any comments that you want to include about the new traffic policy version.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.CreateTrafficPolicyVersionResponse">
<summary>
A complex type that contains the response information for the <code>CreateTrafficPolicyVersion</code>
request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyVersionResponse.TrafficPolicy">
<summary>
Gets and sets the property TrafficPolicy.
<para>
A complex type that contains settings for the new version of the traffic policy.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.CreateTrafficPolicyVersionResponse.Location">
<summary>
Gets and sets the property Location.
</summary>
</member>
<member name="T:Amazon.Route53.Model.DelegationSet">
<summary>
A complex type that contains name server information.
</summary>
</member>
<member name="M:Amazon.Route53.Model.DelegationSet.#ctor">
<summary>
Empty constructor used to set properties independently even when a simple constructor is available
</summary>
</member>
<member name="M:Amazon.Route53.Model.DelegationSet.#ctor(System.Collections.Generic.List{System.String})">
<summary>
Instantiates DelegationSet with the parameterized properties
</summary>
<param name="nameServers">A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each <code>NameServer</code> that is assigned to your hosted zone.</param>
</member>
<member name="P:Amazon.Route53.Model.DelegationSet.Id">
<summary>
Gets and sets the property Id.
</summary>
</member>
<member name="P:Amazon.Route53.Model.DelegationSet.CallerReference">
<summary>
Gets and sets the property CallerReference.
</summary>
</member>
<member name="P:Amazon.Route53.Model.DelegationSet.NameServers">
<summary>
Gets and sets the property NameServers.
<para>
A complex type that contains the authoritative name servers for the hosted zone. Use
the method provided by your domain registrar to add an NS record to your domain for
each <code>NameServer</code> that is assigned to your hosted zone.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.DelegationSetAlreadyCreatedException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetAlreadyCreatedException.#ctor(System.String)">
<summary>
Constructs a new DelegationSetAlreadyCreatedException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetAlreadyCreatedException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of DelegationSetAlreadyCreatedException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetAlreadyCreatedException.#ctor(System.Exception)">
<summary>
Construct instance of DelegationSetAlreadyCreatedException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetAlreadyCreatedException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of DelegationSetAlreadyCreatedException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetAlreadyCreatedException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of DelegationSetAlreadyCreatedException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.DelegationSetAlreadyReusableException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetAlreadyReusableException.#ctor(System.String)">
<summary>
Constructs a new DelegationSetAlreadyReusableException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetAlreadyReusableException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of DelegationSetAlreadyReusableException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetAlreadyReusableException.#ctor(System.Exception)">
<summary>
Construct instance of DelegationSetAlreadyReusableException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetAlreadyReusableException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of DelegationSetAlreadyReusableException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetAlreadyReusableException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of DelegationSetAlreadyReusableException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.DelegationSetInUseException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetInUseException.#ctor(System.String)">
<summary>
Constructs a new DelegationSetInUseException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetInUseException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of DelegationSetInUseException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetInUseException.#ctor(System.Exception)">
<summary>
Construct instance of DelegationSetInUseException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetInUseException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of DelegationSetInUseException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetInUseException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of DelegationSetInUseException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.DelegationSetNotAvailableException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetNotAvailableException.#ctor(System.String)">
<summary>
Constructs a new DelegationSetNotAvailableException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetNotAvailableException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of DelegationSetNotAvailableException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetNotAvailableException.#ctor(System.Exception)">
<summary>
Construct instance of DelegationSetNotAvailableException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetNotAvailableException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of DelegationSetNotAvailableException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetNotAvailableException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of DelegationSetNotAvailableException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.DelegationSetNotReusableException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetNotReusableException.#ctor(System.String)">
<summary>
Constructs a new DelegationSetNotReusableException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetNotReusableException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of DelegationSetNotReusableException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetNotReusableException.#ctor(System.Exception)">
<summary>
Construct instance of DelegationSetNotReusableException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetNotReusableException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of DelegationSetNotReusableException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.DelegationSetNotReusableException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of DelegationSetNotReusableException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.DeleteHealthCheckRequest">
<summary>
Container for the parameters to the DeleteHealthCheck operation.
This action deletes a health check. To delete a health check, send a <code>DELETE</code>
request to the <code>2013-04-01/healthcheck/<i>health check ID</i></code> resource.
<important> You can delete a health check only if there are no resource record sets
associated with this health check. If resource record sets are associated with this
health check, you must disassociate them before you can delete your health check.
If you try to delete a health check that is associated with resource record sets,
Amazon Route 53 will deny your request with a <code>HealthCheckInUse</code> error.
For information about disassociating the records from your health check, see <a>ChangeResourceRecordSets</a>.</important>
</summary>
</member>
<member name="P:Amazon.Route53.Model.DeleteHealthCheckRequest.HealthCheckId">
<summary>
Gets and sets the property HealthCheckId.
<para>
The ID of the health check to delete.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.DeleteHealthCheckResponse">
<summary>
Empty response for the request.
</summary>
</member>
<member name="T:Amazon.Route53.Model.DeleteHostedZoneRequest">
<summary>
Container for the parameters to the DeleteHostedZone operation.
This action deletes a hosted zone. To delete a hosted zone, send a <code>DELETE</code>
request to the <code>2013-04-01/hostedzone/<i>hosted zone ID</i></code> resource.
<para>
For more information about deleting a hosted zone, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DeleteHostedZone.html">Deleting
a Hosted Zone</a> in the <i>Amazon Route 53 Developer Guide</i>.
</para>
<important> You can delete a hosted zone only if there are no resource record sets
other than the default SOA record and NS resource record sets. If your hosted zone
contains other resource record sets, you must delete them before you can delete your
hosted zone. If you try to delete a hosted zone that contains other resource record
sets, Amazon Route 53 will deny your request with a <code>HostedZoneNotEmpty</code>
error. For information about deleting records from your hosted zone, see <a>ChangeResourceRecordSets</a>.</important>
</summary>
</member>
<member name="M:Amazon.Route53.Model.DeleteHostedZoneRequest.#ctor">
<summary>
Empty constructor used to set properties independently even when a simple constructor is available
</summary>
</member>
<member name="M:Amazon.Route53.Model.DeleteHostedZoneRequest.#ctor(System.String)">
<summary>
Instantiates DeleteHostedZoneRequest with the parameterized properties
</summary>
<param name="id">The ID of the hosted zone you want to delete.</param>
</member>
<member name="P:Amazon.Route53.Model.DeleteHostedZoneRequest.Id">
<summary>
Gets and sets the property Id.
<para>
The ID of the hosted zone you want to delete.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.DeleteHostedZoneResponse">
<summary>
A complex type containing the response information for the request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.DeleteHostedZoneResponse.ChangeInfo">
<summary>
Gets and sets the property ChangeInfo.
<para>
A complex type that contains the ID, the status, and the date and time of your delete
request.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.DeleteReusableDelegationSetRequest">
<summary>
Container for the parameters to the DeleteReusableDelegationSet operation.
This action deletes a reusable delegation set. To delete a reusable delegation set,
send a <code>DELETE</code> request to the <code>2013-04-01/delegationset/<i>delegation
set ID</i></code> resource.
<important> You can delete a reusable delegation set only if there are no associated
hosted zones. If your reusable delegation set contains associated hosted zones, you
must delete them before you can delete your reusable delegation set. If you try to
delete a reusable delegation set that contains associated hosted zones, Amazon Route
53 will deny your request with a <code>DelegationSetInUse</code> error.</important>
</summary>
</member>
<member name="P:Amazon.Route53.Model.DeleteReusableDelegationSetRequest.Id">
<summary>
Gets and sets the property Id.
<para>
The ID of the reusable delegation set you want to delete.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.DeleteReusableDelegationSetResponse">
<summary>
Empty response for the request.
</summary>
</member>
<member name="T:Amazon.Route53.Model.DeleteTrafficPolicyInstanceRequest">
<summary>
Container for the parameters to the DeleteTrafficPolicyInstance operation.
Deletes a traffic policy instance and all of the resource record sets that Amazon
Route 53 created when you created the instance.
<para>
To delete a traffic policy instance, send a <code>DELETE</code> request to the <code>2013-04-01/trafficpolicy/<i>traffic
policy instance ID</i></code> resource.
</para>
<important>When you delete a traffic policy instance, Amazon Route 53 also deletes
all of the resource record sets that were created when you created the traffic policy
instance.</important>
</summary>
</member>
<member name="P:Amazon.Route53.Model.DeleteTrafficPolicyInstanceRequest.Id">
<summary>
Gets and sets the property Id.
<para>
The ID of the traffic policy instance that you want to delete.
</para>
<important>When you delete a traffic policy instance, Amazon Route 53 also deletes
all of the resource record sets that were created when you created the traffic policy
instance.</important>
</summary>
</member>
<member name="T:Amazon.Route53.Model.DeleteTrafficPolicyInstanceResponse">
<summary>
An empty element.
</summary>
</member>
<member name="T:Amazon.Route53.Model.DeleteTrafficPolicyRequest">
<summary>
Container for the parameters to the DeleteTrafficPolicy operation.
Deletes a traffic policy. To delete a traffic policy, send a <code>DELETE</code> request
to the <code>2013-04-01/trafficpolicy</code> resource.
</summary>
</member>
<member name="P:Amazon.Route53.Model.DeleteTrafficPolicyRequest.Id">
<summary>
Gets and sets the property Id.
<para>
The ID of the traffic policy that you want to delete.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.DeleteTrafficPolicyRequest.Version">
<summary>
Gets and sets the property Version.
<para>
The version number of the traffic policy that you want to delete.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.DeleteTrafficPolicyResponse">
<summary>
An empty element.
</summary>
</member>
<member name="T:Amazon.Route53.Model.DisassociateVPCFromHostedZoneRequest">
<summary>
Container for the parameters to the DisassociateVPCFromHostedZone operation.
This action disassociates a VPC from an hosted zone.
<para>
To disassociate a VPC to a hosted zone, send a <code>POST</code> request to the <code>2013-04-01/hostedzone/<i>hosted
zone ID</i>/disassociatevpc</code> resource. The request body must include an XML
document with a <code>DisassociateVPCFromHostedZoneRequest</code> element. The response
returns the <code>DisassociateVPCFromHostedZoneResponse</code> element that contains
<code>ChangeInfo</code> for you to track the progress of the <code>DisassociateVPCFromHostedZoneRequest</code>
you made. See <code>GetChange</code> operation for how to track the progress of your
change.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.DisassociateVPCFromHostedZoneRequest.HostedZoneId">
<summary>
Gets and sets the property HostedZoneId.
<para>
The ID of the hosted zone you want to disassociate your VPC from.
</para>
<para>
Note that you cannot disassociate the last VPC from a hosted zone.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.DisassociateVPCFromHostedZoneRequest.VPC">
<summary>
Gets and sets the property VPC.
<para>
The VPC that you want your hosted zone to be disassociated from.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.DisassociateVPCFromHostedZoneRequest.Comment">
<summary>
Gets and sets the property Comment.
<para>
<i>Optional:</i> Any comments you want to include about a <code>DisassociateVPCFromHostedZoneRequest</code>.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.DisassociateVPCFromHostedZoneResponse">
<summary>
A complex type containing the response information for the request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.DisassociateVPCFromHostedZoneResponse.ChangeInfo">
<summary>
Gets and sets the property ChangeInfo.
<para>
A complex type that contains the ID, the status, and the date and time of your <code>DisassociateVPCFromHostedZoneRequest</code>.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GeoLocation">
<summary>
A complex type that contains information about a geo location.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GeoLocation.ContinentCode">
<summary>
Gets and sets the property ContinentCode.
<para>
The code for a continent geo location. Note: only continent locations have a continent
code.
</para>
<para>
Valid values: <code>AF</code> | <code>AN</code> | <code>AS</code> | <code>EU</code>
| <code>OC</code> | <code>NA</code> | <code>SA</code>
</para>
<para>
Constraint: Specifying <code>ContinentCode</code> with either <code>CountryCode</code>
or <code>SubdivisionCode</code> returns an <a>InvalidInput</a> error.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.GeoLocation.CountryCode">
<summary>
Gets and sets the property CountryCode.
<para>
The code for a country geo location. The default location uses '*' for the country
code and will match all locations that are not matched by a geo location.
</para>
<para>
The default geo location uses a <code>*</code> for the country code. All other country
codes follow the ISO 3166 two-character code.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.GeoLocation.SubdivisionCode">
<summary>
Gets and sets the property SubdivisionCode.
<para>
The code for a country's subdivision (e.g., a province of Canada). A subdivision code
is only valid with the appropriate country code.
</para>
<para>
Constraint: Specifying <code>SubdivisionCode</code> without <code>CountryCode</code>
returns an <a>InvalidInput</a> error.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GeoLocationDetails">
<summary>
A complex type that contains information about a <code>GeoLocation</code>.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GeoLocationDetails.ContinentCode">
<summary>
Gets and sets the property ContinentCode.
<para>
The code for a continent geo location. Note: only continent locations have a continent
code.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.GeoLocationDetails.ContinentName">
<summary>
Gets and sets the property ContinentName.
<para>
The name of the continent. This element is only present if <code>ContinentCode</code>
is also present.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.GeoLocationDetails.CountryCode">
<summary>
Gets and sets the property CountryCode.
<para>
The code for a country geo location. The default location uses '*' for the country
code and will match all locations that are not matched by a geo location.
</para>
<para>
The default geo location uses a <code>*</code> for the country code. All other country
codes follow the ISO 3166 two-character code.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.GeoLocationDetails.CountryName">
<summary>
Gets and sets the property CountryName.
<para>
The name of the country. This element is only present if <code>CountryCode</code>
is also present.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.GeoLocationDetails.SubdivisionCode">
<summary>
Gets and sets the property SubdivisionCode.
<para>
The code for a country's subdivision (e.g., a province of Canada). A subdivision code
is only valid with the appropriate country code.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.GeoLocationDetails.SubdivisionName">
<summary>
Gets and sets the property SubdivisionName.
<para>
The name of the subdivision. This element is only present if <code>SubdivisionCode</code>
is also present.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetChangeDetailsRequest">
<summary>
Container for the parameters to the GetChangeDetails operation.
This action returns the status and changes of a change batch request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetChangeDetailsRequest.Id">
<summary>
Gets and sets the property Id.
<para>
The ID of the change batch request. The value that you specify here is the value that
<code>ChangeResourceRecordSets</code> returned in the Id element when you submitted
the request.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetChangeDetailsResponse">
<summary>
A complex type that contains the <code>ChangeBatchRecord</code> element.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetChangeDetailsResponse.ChangeBatchRecord">
<summary>
Gets and sets the property ChangeBatchRecord.
<para>
A complex type that contains information about the specified change batch, including
the change batch ID, the status of the change, and the contained changes.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetChangeRequest">
<summary>
Container for the parameters to the GetChange operation.
This action returns the current status of a change batch request. The status is one
of the following values:
<para>
- <code>PENDING</code> indicates that the changes in this request have not replicated
to all Amazon Route 53 DNS servers. This is the initial status of all change batch
requests.
</para>
<para>
- <code>INSYNC</code> indicates that the changes have replicated to all Amazon Route
53 DNS servers.
</para>
</summary>
</member>
<member name="M:Amazon.Route53.Model.GetChangeRequest.#ctor">
<summary>
Empty constructor used to set properties independently even when a simple constructor is available
</summary>
</member>
<member name="M:Amazon.Route53.Model.GetChangeRequest.#ctor(System.String)">
<summary>
Instantiates GetChangeRequest with the parameterized properties
</summary>
<param name="id">The ID of the change batch request. The value that you specify here is the value that <code>ChangeResourceRecordSets</code> returned in the Id element when you submitted the request.</param>
</member>
<member name="P:Amazon.Route53.Model.GetChangeRequest.Id">
<summary>
Gets and sets the property Id.
<para>
The ID of the change batch request. The value that you specify here is the value that
<code>ChangeResourceRecordSets</code> returned in the Id element when you submitted
the request.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetChangeResponse">
<summary>
A complex type that contains the <code>ChangeInfo</code> element.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetChangeResponse.ChangeInfo">
<summary>
Gets and sets the property ChangeInfo.
<para>
A complex type that contains information about the specified change batch, including
the change batch ID, the status of the change, and the date and time of the request.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetCheckerIpRangesRequest">
<summary>
Container for the parameters to the GetCheckerIpRanges operation.
To retrieve a list of the IP ranges used by Amazon Route 53 health checkers to check
the health of your resources, send a <code>GET</code> request to the <code>2013-04-01/checkeripranges</code>
resource. You can use these IP addresses to configure router and firewall rules to
allow health checkers to check the health of your resources.
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetCheckerIpRangesResponse">
<summary>
A complex type that contains the <code>CheckerIpRanges</code> element.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetCheckerIpRangesResponse.CheckerIpRanges">
<summary>
Gets and sets the property CheckerIpRanges.
<para>
A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route
53 health checkers.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetGeoLocationRequest">
<summary>
Container for the parameters to the GetGeoLocation operation.
To retrieve a single geo location, send a <code>GET</code> request to the <code>2013-04-01/geolocation</code>
resource with one of these options: continentcode | countrycode | countrycode and
subdivisioncode.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetGeoLocationRequest.ContinentCode">
<summary>
Gets and sets the property ContinentCode.
<para>
The code for a continent geo location. Note: only continent locations have a continent
code.
</para>
<para>
Valid values: <code>AF</code> | <code>AN</code> | <code>AS</code> | <code>EU</code>
| <code>OC</code> | <code>NA</code> | <code>SA</code>
</para>
<para>
Constraint: Specifying <code>ContinentCode</code> with either <code>CountryCode</code>
or <code>SubdivisionCode</code> returns an <a>InvalidInput</a> error.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetGeoLocationRequest.CountryCode">
<summary>
Gets and sets the property CountryCode.
<para>
The code for a country geo location. The default location uses '*' for the country
code and will match all locations that are not matched by a geo location.
</para>
<para>
The default geo location uses a <code>*</code> for the country code. All other country
codes follow the ISO 3166 two-character code.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetGeoLocationRequest.SubdivisionCode">
<summary>
Gets and sets the property SubdivisionCode.
<para>
The code for a country's subdivision (e.g., a province of Canada). A subdivision code
is only valid with the appropriate country code.
</para>
<para>
Constraint: Specifying <code>SubdivisionCode</code> without <code>CountryCode</code>
returns an <a>InvalidInput</a> error.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetGeoLocationResponse">
<summary>
A complex type containing information about the specified geo location.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetGeoLocationResponse.GeoLocationDetails">
<summary>
Gets and sets the property GeoLocationDetails.
<para>
A complex type that contains the information about the specified geo location.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetHealthCheckCountRequest">
<summary>
Container for the parameters to the GetHealthCheckCount operation.
To retrieve a count of all your health checks, send a <code>GET</code> request to
the <code>2013-04-01/healthcheckcount</code> resource.
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetHealthCheckCountResponse">
<summary>
A complex type that contains the count of health checks associated with the current
AWS account.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetHealthCheckCountResponse.HealthCheckCount">
<summary>
Gets and sets the property HealthCheckCount.
<para>
The number of health checks associated with the current AWS account.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetHealthCheckLastFailureReasonRequest">
<summary>
Container for the parameters to the GetHealthCheckLastFailureReason operation.
If you want to learn why a health check is currently failing or why it failed most
recently (if at all), you can get the failure reason for the most recent failure.
Send a <code>GET</code> request to the <code>2013-04-01/healthcheck/<i>health check
ID</i>/lastfailurereason</code> resource.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetHealthCheckLastFailureReasonRequest.HealthCheckId">
<summary>
Gets and sets the property HealthCheckId.
<para>
The ID of the health check for which you want to retrieve the reason for the most
recent failure.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetHealthCheckLastFailureReasonResponse">
<summary>
A complex type that contains information about the most recent failure for the specified
health check.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetHealthCheckLastFailureReasonResponse.HealthCheckObservations">
<summary>
Gets and sets the property HealthCheckObservations.
<para>
A list that contains one <code>HealthCheckObservation</code> element for each Amazon
Route 53 health checker.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetHealthCheckRequest">
<summary>
Container for the parameters to the GetHealthCheck operation.
To retrieve the health check, send a <code>GET</code> request to the <code>2013-04-01/healthcheck/<i>health
check ID</i></code> resource.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetHealthCheckRequest.HealthCheckId">
<summary>
Gets and sets the property HealthCheckId.
<para>
The ID of the health check to retrieve.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetHealthCheckResponse">
<summary>
A complex type containing information about the specified health check.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetHealthCheckResponse.HealthCheck">
<summary>
Gets and sets the property HealthCheck.
<para>
A complex type that contains the information about the specified health check.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetHealthCheckStatusRequest">
<summary>
Container for the parameters to the GetHealthCheckStatus operation.
To retrieve the health check status, send a <code>GET</code> request to the <code>2013-04-01/healthcheck/<i>health
check ID</i>/status</code> resource. You can use this call to get a health check's
current status.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetHealthCheckStatusRequest.HealthCheckId">
<summary>
Gets and sets the property HealthCheckId.
<para>
If you want Amazon Route 53 to return this resource record set in response to a DNS
query only when a health check is passing, include the <code>HealthCheckId</code>
element and specify the ID of the applicable health check.
</para>
<para>
Amazon Route 53 determines whether a resource record set is healthy by periodically
sending a request to the endpoint that is specified in the health check. If that endpoint
returns an HTTP status code of 2xx or 3xx, the endpoint is healthy. If the endpoint
returns an HTTP status code of 400 or greater, or if the endpoint doesn't respond
for a certain amount of time, Amazon Route 53 considers the endpoint unhealthy and
also considers the resource record set unhealthy.
</para>
<para>
The <code>HealthCheckId</code> element is only useful when Amazon Route 53 is choosing
between two or more resource record sets to respond to a DNS query, and you want Amazon
Route 53 to base the choice in part on the status of a health check. Configuring health
checks only makes sense in the following configurations:
</para>
<ul> <li>You're checking the health of the resource record sets in a weighted, latency,
geolocation, or failover resource record set, and you specify health check IDs for
all of the resource record sets. If the health check for one resource record set specifies
an endpoint that is not healthy, Amazon Route 53 stops responding to queries using
the value for that resource record set.</li> <li>
<para>
You set <code>EvaluateTargetHealth</code> to <code>true</code> for the resource record
sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias
resource record set, and you specify health check IDs for all of the resource record
sets that are referenced by the alias resource record sets. For more information about
this configuration, see <a>EvaluateTargetHealth</a>.
</para>
<para>
Amazon Route 53 doesn't check the health of the endpoint specified in the resource
record set, for example, the endpoint specified by the IP address in the <code>Value</code>
element. When you add a <code>HealthCheckId</code> element to a resource record set,
Amazon Route 53 checks the health of the endpoint that you specified in the health
check.
</para>
</li> </ul>
<para>
For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53
looks for a resource record set for the larger, associated geographic region. For
example, suppose you have resource record sets for a state in the United States, for
the United States, for North America, and for all locations. If the endpoint for the
state resource record set is unhealthy, Amazon Route 53 checks the resource record
sets for the United States, for North America, and for all locations (a resource record
set for which the value of CountryCode is <code>*</code>), in that order, until it
finds a resource record set for which the endpoint is healthy.
</para>
<para>
If your health checks specify the endpoint only by domain name, we recommend that
you create a separate health check for each endpoint. For example, create a health
check for each HTTP server that is serving content for www.example.com. For the value
of <code>FullyQualifiedDomainName</code>, specify the domain name of the server (such
as <code>us-east-1-www.example.com</code>), not the name of the resource record sets
(example.com).
</para>
<important>In this configuration, if you create a health check for which the value
of <code>FullyQualifiedDomainName</code> matches the name of the resource record sets
and then associate the health check with those resource record sets, health check
results will be unpredictable.</important>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetHealthCheckStatusResponse">
<summary>
A complex type that contains information about the status of the specified health
check.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetHealthCheckStatusResponse.HealthCheckObservations">
<summary>
Gets and sets the property HealthCheckObservations.
<para>
A list that contains one <code>HealthCheckObservation</code> element for each Amazon
Route 53 health checker.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetHostedZoneCountRequest">
<summary>
Container for the parameters to the GetHostedZoneCount operation.
To retrieve a count of all your hosted zones, send a <code>GET</code> request to the
<code>2013-04-01/hostedzonecount</code> resource.
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetHostedZoneCountResponse">
<summary>
A complex type that contains the count of hosted zones associated with the current
AWS account.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetHostedZoneCountResponse.HostedZoneCount">
<summary>
Gets and sets the property HostedZoneCount.
<para>
The number of hosted zones associated with the current AWS account.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetHostedZoneRequest">
<summary>
Container for the parameters to the GetHostedZone operation.
To retrieve the delegation set for a hosted zone, send a <code>GET</code> request
to the <code>2013-04-01/hostedzone/<i>hosted zone ID</i></code> resource. The delegation
set is the four Amazon Route 53 name servers that were assigned to the hosted zone
when you created it.
</summary>
</member>
<member name="M:Amazon.Route53.Model.GetHostedZoneRequest.#ctor">
<summary>
Empty constructor used to set properties independently even when a simple constructor is available
</summary>
</member>
<member name="M:Amazon.Route53.Model.GetHostedZoneRequest.#ctor(System.String)">
<summary>
Instantiates GetHostedZoneRequest with the parameterized properties
</summary>
<param name="id">The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.</param>
</member>
<member name="P:Amazon.Route53.Model.GetHostedZoneRequest.Id">
<summary>
Gets and sets the property Id.
<para>
The ID of the hosted zone for which you want to get a list of the name servers in
the delegation set.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetHostedZoneResponse">
<summary>
A complex type containing information about the specified hosted zone.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetHostedZoneResponse.HostedZone">
<summary>
Gets and sets the property HostedZone.
<para>
A complex type that contains the information about the specified hosted zone.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetHostedZoneResponse.DelegationSet">
<summary>
Gets and sets the property DelegationSet.
<para>
A complex type that contains information about the name servers for the specified
hosted zone.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetHostedZoneResponse.VPCs">
<summary>
Gets and sets the property VPCs.
<para>
A complex type that contains information about VPCs associated with the specified
hosted zone.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetReusableDelegationSetRequest">
<summary>
Container for the parameters to the GetReusableDelegationSet operation.
To retrieve the reusable delegation set, send a <code>GET</code> request to the <code>2013-04-01/delegationset/<i>delegation
set ID</i></code> resource.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetReusableDelegationSetRequest.Id">
<summary>
Gets and sets the property Id.
<para>
The ID of the reusable delegation set for which you want to get a list of the name
server.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetReusableDelegationSetResponse">
<summary>
A complex type containing information about the specified reusable delegation set.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetReusableDelegationSetResponse.DelegationSet">
<summary>
Gets and sets the property DelegationSet.
<para>
A complex type that contains the information about the nameservers for the specified
delegation set ID.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetTrafficPolicyInstanceCountRequest">
<summary>
Container for the parameters to the GetTrafficPolicyInstanceCount operation.
Gets the number of traffic policy instances that are associated with the current AWS
account.
<para>
To get the number of traffic policy instances, send a <code>GET</code> request to
the <code>2013-04-01/trafficpolicyinstancecount</code> resource.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetTrafficPolicyInstanceCountResponse">
<summary>
A complex type that contains information about the number of traffic policy instances
that are associated with the current AWS account.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetTrafficPolicyInstanceCountResponse.TrafficPolicyInstanceCount">
<summary>
Gets and sets the property TrafficPolicyInstanceCount.
<para>
The number of traffic policy instances that are associated with the current AWS account.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetTrafficPolicyInstanceRequest">
<summary>
Container for the parameters to the GetTrafficPolicyInstance operation.
Gets information about a specified traffic policy instance.
<para>
To get information about the traffic policy instance, send a <code>GET</code> request
to the <code>2013-04-01/trafficpolicyinstance</code> resource.
</para>
<note>After you submit a <code>CreateTrafficPolicyInstance</code> or an <code>UpdateTrafficPolicyInstance</code>
request, there's a brief delay while Amazon Route 53 creates the resource record sets
that are specified in the traffic policy definition. For more information, see the
<a>State</a> response element. </note>
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetTrafficPolicyInstanceRequest.Id">
<summary>
Gets and sets the property Id.
<para>
The ID of the traffic policy instance that you want to get information about.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetTrafficPolicyInstanceResponse">
<summary>
A complex type that contains information about the resource record sets that Amazon
Route 53 created based on a specified traffic policy.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetTrafficPolicyInstanceResponse.TrafficPolicyInstance">
<summary>
Gets and sets the property TrafficPolicyInstance.
<para>
A complex type that contains settings for the traffic policy instance.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetTrafficPolicyRequest">
<summary>
Container for the parameters to the GetTrafficPolicy operation.
Gets information about a specific traffic policy version. To get the information,
send a <code>GET</code> request to the <code>2013-04-01/trafficpolicy</code> resource.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetTrafficPolicyRequest.Id">
<summary>
Gets and sets the property Id.
<para>
The ID of the traffic policy that you want to get information about.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetTrafficPolicyRequest.Version">
<summary>
Gets and sets the property Version.
<para>
The version number of the traffic policy that you want to get information about.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.GetTrafficPolicyResponse">
<summary>
A complex type that contains the response information for the request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.GetTrafficPolicyResponse.TrafficPolicy">
<summary>
Gets and sets the property TrafficPolicy.
<para>
A complex type that contains settings for the specified traffic policy.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.HealthCheck">
<summary>
A complex type that contains identifying information about the health check.
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheck.Id">
<summary>
Gets and sets the property Id.
<para>
The ID of the specified health check.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheck.CallerReference">
<summary>
Gets and sets the property CallerReference.
<para>
A unique string that identifies the request to create the health check.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheck.HealthCheckConfig">
<summary>
Gets and sets the property HealthCheckConfig.
<para>
A complex type that contains the health check configuration.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheck.HealthCheckVersion">
<summary>
Gets and sets the property HealthCheckVersion.
<para>
The version of the health check. You can optionally pass this value in a call to <code>UpdateHealthCheck</code>
to prevent overwriting another change to the health check.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.HealthCheckAlreadyExistsException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.HealthCheckAlreadyExistsException.#ctor(System.String)">
<summary>
Constructs a new HealthCheckAlreadyExistsException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.HealthCheckAlreadyExistsException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of HealthCheckAlreadyExistsException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.HealthCheckAlreadyExistsException.#ctor(System.Exception)">
<summary>
Construct instance of HealthCheckAlreadyExistsException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.HealthCheckAlreadyExistsException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of HealthCheckAlreadyExistsException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.HealthCheckAlreadyExistsException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of HealthCheckAlreadyExistsException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.HealthCheckConfig">
<summary>
A complex type that contains the health check configuration.
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheckConfig.IPAddress">
<summary>
Gets and sets the property IPAddress.
<para>
IP Address of the instance being checked.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheckConfig.Port">
<summary>
Gets and sets the property Port.
<para>
Port on which connection will be opened to the instance to health check. For HTTP
and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and
HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheckConfig.Type">
<summary>
Gets and sets the property Type.
<para>
The type of health check to be performed. Currently supported types are TCP, HTTP,
HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheckConfig.ResourcePath">
<summary>
Gets and sets the property ResourcePath.
<para>
Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH,
and HTTPS_STR_MATCH health checks. The HTTP request is issued to the instance on the
given port and path.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheckConfig.FullyQualifiedDomainName">
<summary>
Gets and sets the property FullyQualifiedDomainName.
<para>
Fully qualified domain name of the instance to be health checked.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheckConfig.SearchString">
<summary>
Gets and sets the property SearchString.
<para>
A string to search for in the body of a health check response. Required for HTTP_STR_MATCH
and HTTPS_STR_MATCH health checks.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheckConfig.RequestInterval">
<summary>
Gets and sets the property RequestInterval.
<para>
The number of seconds between the time that Amazon Route 53 gets a response from your
endpoint and the time that it sends the next health-check request.
</para>
<para>
Each Amazon Route 53 health checker makes requests at this interval. Valid values
are 10 and 30. The default value is 30.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheckConfig.FailureThreshold">
<summary>
Gets and sets the property FailureThreshold.
<para>
The number of consecutive health checks that an endpoint must pass or fail for Amazon
Route 53 to change the current status of the endpoint from unhealthy to healthy or
vice versa.
</para>
<para>
Valid values are integers between 1 and 10. For more information, see "How Amazon
Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer
Guide.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheckConfig.MeasureLatency">
<summary>
Gets and sets the property MeasureLatency.
<para>
A Boolean value that indicates whether you want Amazon Route 53 to measure the latency
between health checkers in multiple AWS regions and your endpoint and to display CloudWatch
latency graphs in the Amazon Route 53 console.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheckConfig.Inverted">
<summary>
Gets and sets the property Inverted.
<para>
A boolean value that indicates whether the status of health check should be inverted.
For example, if a health check is healthy but <code>Inverted</code> is <code>True</code>,
then Amazon Route 53 considers the health check to be unhealthy.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheckConfig.HealthThreshold">
<summary>
Gets and sets the property HealthThreshold.
<para>
The minimum number of child health checks that must be healthy for Amazon Route 53
to consider the parent health check to be healthy. Valid values are integers between
0 and 256, inclusive.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheckConfig.ChildHealthChecks">
<summary>
Gets and sets the property ChildHealthChecks.
<para>
For a specified parent health check, a list of <code>HealthCheckId</code> values for
the associated child health checks.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.HealthCheckInUseException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.HealthCheckInUseException.#ctor(System.String)">
<summary>
Constructs a new HealthCheckInUseException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.HealthCheckInUseException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of HealthCheckInUseException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.HealthCheckInUseException.#ctor(System.Exception)">
<summary>
Construct instance of HealthCheckInUseException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.HealthCheckInUseException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of HealthCheckInUseException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.HealthCheckInUseException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of HealthCheckInUseException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.HealthCheckObservation">
<summary>
A complex type that contains the IP address of a Amazon Route 53 health checker and
the reason for the health check status.
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheckObservation.IPAddress">
<summary>
Gets and sets the property IPAddress.
<para>
The IP address of the Amazon Route 53 health checker that performed the health check.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HealthCheckObservation.StatusReport">
<summary>
Gets and sets the property StatusReport.
<para>
A complex type that contains information about the health check status for the current
observation.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.HealthCheckVersionMismatchException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.HealthCheckVersionMismatchException.#ctor(System.String)">
<summary>
Constructs a new HealthCheckVersionMismatchException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.HealthCheckVersionMismatchException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of HealthCheckVersionMismatchException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.HealthCheckVersionMismatchException.#ctor(System.Exception)">
<summary>
Construct instance of HealthCheckVersionMismatchException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.HealthCheckVersionMismatchException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of HealthCheckVersionMismatchException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.HealthCheckVersionMismatchException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of HealthCheckVersionMismatchException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.HostedZone">
<summary>
A complex type that contain information about the specified hosted zone.
</summary>
</member>
<member name="M:Amazon.Route53.Model.HostedZone.#ctor">
<summary>
Empty constructor used to set properties independently even when a simple constructor is available
</summary>
</member>
<member name="M:Amazon.Route53.Model.HostedZone.#ctor(System.String,System.String,System.String)">
<summary>
Instantiates HostedZone with the parameterized properties
</summary>
<param name="id">The ID of the specified hosted zone.</param>
<param name="name">The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical. This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of <code>NameServers</code> elements returned in <code>DelegationSet</code>.</param>
<param name="callerReference">A unique string that identifies the request to create the hosted zone.</param>
</member>
<member name="P:Amazon.Route53.Model.HostedZone.Id">
<summary>
Gets and sets the property Id.
<para>
The ID of the specified hosted zone.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HostedZone.Name">
<summary>
Gets and sets the property Name.
<para>
The name of the domain. This must be a fully-specified domain, for example, www.example.com.
The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully
qualified. This means that Amazon Route 53 treats www.example.com (without a trailing
dot) and www.example.com. (with a trailing dot) as identical.
</para>
<para>
This is the name you have registered with your DNS registrar. You should ask your
registrar to change the authoritative name servers for your domain to the set of <code>NameServers</code>
elements returned in <code>DelegationSet</code>.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HostedZone.CallerReference">
<summary>
Gets and sets the property CallerReference.
<para>
A unique string that identifies the request to create the hosted zone.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HostedZone.Config">
<summary>
Gets and sets the property Config.
<para>
A complex type that contains the <code>Comment</code> element.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HostedZone.ResourceRecordSetCount">
<summary>
Gets and sets the property ResourceRecordSetCount.
<para>
Total number of resource record sets in the hosted zone.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.HostedZoneAlreadyExistsException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneAlreadyExistsException.#ctor(System.String)">
<summary>
Constructs a new HostedZoneAlreadyExistsException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneAlreadyExistsException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of HostedZoneAlreadyExistsException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneAlreadyExistsException.#ctor(System.Exception)">
<summary>
Construct instance of HostedZoneAlreadyExistsException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneAlreadyExistsException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of HostedZoneAlreadyExistsException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneAlreadyExistsException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of HostedZoneAlreadyExistsException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.HostedZoneConfig">
<summary>
A complex type that contains an optional comment about your hosted zone. If you don't
want to specify a comment, you can omit the <code>HostedZoneConfig</code> and <code>Comment</code>
elements from the XML document.
</summary>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneConfig.#ctor">
<summary>
Empty constructor used to set properties independently even when a simple constructor is available
</summary>
</member>
<member name="P:Amazon.Route53.Model.HostedZoneConfig.Comment">
<summary>
Gets and sets the property Comment.
<para>
An optional comment about your hosted zone. If you don't want to specify a comment,
you can omit the <code>HostedZoneConfig</code> and <code>Comment</code> elements from
the XML document.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.HostedZoneConfig.PrivateZone">
<summary>
Gets and sets the property PrivateZone.
</summary>
</member>
<member name="T:Amazon.Route53.Model.HostedZoneNotEmptyException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneNotEmptyException.#ctor(System.String)">
<summary>
Constructs a new HostedZoneNotEmptyException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneNotEmptyException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of HostedZoneNotEmptyException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneNotEmptyException.#ctor(System.Exception)">
<summary>
Construct instance of HostedZoneNotEmptyException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneNotEmptyException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of HostedZoneNotEmptyException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneNotEmptyException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of HostedZoneNotEmptyException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.HostedZoneNotFoundException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneNotFoundException.#ctor(System.String)">
<summary>
Constructs a new HostedZoneNotFoundException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneNotFoundException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of HostedZoneNotFoundException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneNotFoundException.#ctor(System.Exception)">
<summary>
Construct instance of HostedZoneNotFoundException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneNotFoundException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of HostedZoneNotFoundException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.HostedZoneNotFoundException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of HostedZoneNotFoundException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.IncompatibleVersionException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.IncompatibleVersionException.#ctor(System.String)">
<summary>
Constructs a new IncompatibleVersionException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.IncompatibleVersionException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of IncompatibleVersionException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.IncompatibleVersionException.#ctor(System.Exception)">
<summary>
Construct instance of IncompatibleVersionException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.IncompatibleVersionException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of IncompatibleVersionException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.IncompatibleVersionException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of IncompatibleVersionException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.InvalidArgumentException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.InvalidArgumentException.#ctor(System.String)">
<summary>
Constructs a new InvalidArgumentException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.InvalidArgumentException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of InvalidArgumentException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidArgumentException.#ctor(System.Exception)">
<summary>
Construct instance of InvalidArgumentException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidArgumentException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of InvalidArgumentException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidArgumentException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of InvalidArgumentException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.InvalidChangeBatchException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.InvalidChangeBatchException.#ctor(System.String)">
<summary>
Constructs a new InvalidChangeBatchException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.InvalidChangeBatchException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of InvalidChangeBatchException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidChangeBatchException.#ctor(System.Exception)">
<summary>
Construct instance of InvalidChangeBatchException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidChangeBatchException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of InvalidChangeBatchException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidChangeBatchException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of InvalidChangeBatchException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.InvalidDomainNameException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.InvalidDomainNameException.#ctor(System.String)">
<summary>
Constructs a new InvalidDomainNameException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.InvalidDomainNameException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of InvalidDomainNameException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidDomainNameException.#ctor(System.Exception)">
<summary>
Construct instance of InvalidDomainNameException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidDomainNameException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of InvalidDomainNameException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidDomainNameException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of InvalidDomainNameException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.InvalidInputException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.InvalidInputException.#ctor(System.String)">
<summary>
Constructs a new InvalidInputException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.InvalidInputException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of InvalidInputException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidInputException.#ctor(System.Exception)">
<summary>
Construct instance of InvalidInputException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidInputException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of InvalidInputException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidInputException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of InvalidInputException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.InvalidTrafficPolicyDocumentException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.InvalidTrafficPolicyDocumentException.#ctor(System.String)">
<summary>
Constructs a new InvalidTrafficPolicyDocumentException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.InvalidTrafficPolicyDocumentException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of InvalidTrafficPolicyDocumentException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidTrafficPolicyDocumentException.#ctor(System.Exception)">
<summary>
Construct instance of InvalidTrafficPolicyDocumentException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidTrafficPolicyDocumentException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of InvalidTrafficPolicyDocumentException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidTrafficPolicyDocumentException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of InvalidTrafficPolicyDocumentException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.InvalidVPCIdException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.InvalidVPCIdException.#ctor(System.String)">
<summary>
Constructs a new InvalidVPCIdException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.InvalidVPCIdException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of InvalidVPCIdException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidVPCIdException.#ctor(System.Exception)">
<summary>
Construct instance of InvalidVPCIdException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidVPCIdException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of InvalidVPCIdException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.InvalidVPCIdException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of InvalidVPCIdException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.LastVPCAssociationException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.LastVPCAssociationException.#ctor(System.String)">
<summary>
Constructs a new LastVPCAssociationException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.LastVPCAssociationException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of LastVPCAssociationException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.LastVPCAssociationException.#ctor(System.Exception)">
<summary>
Construct instance of LastVPCAssociationException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.LastVPCAssociationException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of LastVPCAssociationException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.LastVPCAssociationException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of LastVPCAssociationException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.LimitsExceededException">
<summary>
Route53 exception
</summary>
</member>
<member name="M:Amazon.Route53.Model.LimitsExceededException.#ctor(System.String)">
<summary>
Constructs a new LimitsExceededException with the specified error
message.
</summary>
<param name="message">
Describes the error encountered.
</param>
</member>
<member name="M:Amazon.Route53.Model.LimitsExceededException.#ctor(System.String,System.Exception)">
<summary>
Construct instance of LimitsExceededException
</summary>
<param name="message"></param>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.LimitsExceededException.#ctor(System.Exception)">
<summary>
Construct instance of LimitsExceededException
</summary>
<param name="innerException"></param>
</member>
<member name="M:Amazon.Route53.Model.LimitsExceededException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of LimitsExceededException
</summary>
<param name="message"></param>
<param name="innerException"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="M:Amazon.Route53.Model.LimitsExceededException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)">
<summary>
Construct instance of LimitsExceededException
</summary>
<param name="message"></param>
<param name="errorType"></param>
<param name="errorCode"></param>
<param name="requestId"></param>
<param name="statusCode"></param>
</member>
<member name="T:Amazon.Route53.Model.ListChangeBatchesByHostedZoneRequest">
<summary>
Container for the parameters to the ListChangeBatchesByHostedZone operation.
This action gets the list of ChangeBatches in a given time period for a given hosted
zone.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByHostedZoneRequest.HostedZoneId">
<summary>
Gets and sets the property HostedZoneId.
<para>
The ID of the hosted zone that you want to see changes for.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByHostedZoneRequest.StartDate">
<summary>
Gets and sets the property StartDate.
<para>
The start of the time period you want to see changes for.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByHostedZoneRequest.EndDate">
<summary>
Gets and sets the property EndDate.
<para>
The end of the time period you want to see changes for.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByHostedZoneRequest.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of items on a page.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByHostedZoneRequest.Marker">
<summary>
Gets and sets the property Marker.
<para>
The page marker.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListChangeBatchesByHostedZoneResponse">
<summary>
The input for a ListChangeBatchesByHostedZone request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByHostedZoneResponse.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of items on a page.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByHostedZoneResponse.Marker">
<summary>
Gets and sets the property Marker.
<para>
The page marker.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByHostedZoneResponse.IsTruncated">
<summary>
Gets and sets the property IsTruncated.
<para>
A flag that indicates if there are more change batches to list.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByHostedZoneResponse.ChangeBatchRecords">
<summary>
Gets and sets the property ChangeBatchRecords.
<para>
The change batches within the given hosted zone and time period.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByHostedZoneResponse.NextMarker">
<summary>
Gets and sets the property NextMarker.
<para>
The next page marker.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListChangeBatchesByRRSetRequest">
<summary>
Container for the parameters to the ListChangeBatchesByRRSet operation.
This action gets the list of ChangeBatches in a given time period for a given hosted
zone and RRSet.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByRRSetRequest.HostedZoneId">
<summary>
Gets and sets the property HostedZoneId.
<para>
The ID of the hosted zone that you want to see changes for.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByRRSetRequest.Name">
<summary>
Gets and sets the property Name.
<para>
The name of the RRSet that you want to see changes for.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByRRSetRequest.Type">
<summary>
Gets and sets the property Type.
<para>
The type of the RRSet that you want to see changes for.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByRRSetRequest.SetIdentifier">
<summary>
Gets and sets the property SetIdentifier.
<para>
The identifier of the RRSet that you want to see changes for.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByRRSetRequest.StartDate">
<summary>
Gets and sets the property StartDate.
<para>
The start of the time period you want to see changes for.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByRRSetRequest.EndDate">
<summary>
Gets and sets the property EndDate.
<para>
The end of the time period you want to see changes for.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByRRSetRequest.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of items on a page.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByRRSetRequest.Marker">
<summary>
Gets and sets the property Marker.
<para>
The page marker.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListChangeBatchesByRRSetResponse">
<summary>
The input for a ListChangeBatchesByRRSet request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByRRSetResponse.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of items on a page.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByRRSetResponse.Marker">
<summary>
Gets and sets the property Marker.
<para>
The page marker.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByRRSetResponse.IsTruncated">
<summary>
Gets and sets the property IsTruncated.
<para>
A flag that indicates if there are more change batches to list.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByRRSetResponse.ChangeBatchRecords">
<summary>
Gets and sets the property ChangeBatchRecords.
<para>
The change batches within the given hosted zone and time period.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListChangeBatchesByRRSetResponse.NextMarker">
<summary>
Gets and sets the property NextMarker.
<para>
The next page marker.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListGeoLocationsRequest">
<summary>
Container for the parameters to the ListGeoLocations operation.
To retrieve a list of supported geo locations, send a <code>GET</code> request to
the <code>2013-04-01/geolocations</code> resource. The response to this request includes
a <code>GeoLocationDetailsList</code> element with zero, one, or multiple <code>GeoLocationDetails</code>
child elements. The list is sorted by country code, and then subdivision code, followed
by continents at the end of the list.
<para>
By default, the list of geo locations is displayed on a single page. You can control
the length of the page that is displayed by using the <code>MaxItems</code> parameter.
If the list is truncated, <code>IsTruncated</code> will be set to <i>true</i> and
a combination of <code>NextContinentCode, NextCountryCode, NextSubdivisionCode</code>
will be populated. You can pass these as parameters to <code>StartContinentCode, StartCountryCode,
StartSubdivisionCode</code> to control the geo location that the list begins with.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListGeoLocationsRequest.StartContinentCode">
<summary>
Gets and sets the property StartContinentCode.
<para>
The first continent code in the lexicographic ordering of geo locations that you want
the <code>ListGeoLocations</code> request to list. For non-continent geo locations,
this should be null.
</para>
<para>
Valid values: <code>AF</code> | <code>AN</code> | <code>AS</code> | <code>EU</code>
| <code>OC</code> | <code>NA</code> | <code>SA</code>
</para>
<para>
Constraint: Specifying <code>ContinentCode</code> with either <code>CountryCode</code>
or <code>SubdivisionCode</code> returns an <a>InvalidInput</a> error.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListGeoLocationsRequest.StartCountryCode">
<summary>
Gets and sets the property StartCountryCode.
<para>
The first country code in the lexicographic ordering of geo locations that you want
the <code>ListGeoLocations</code> request to list.
</para>
<para>
The default geo location uses a <code>*</code> for the country code. All other country
codes follow the ISO 3166 two-character code.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListGeoLocationsRequest.StartSubdivisionCode">
<summary>
Gets and sets the property StartSubdivisionCode.
<para>
The first subdivision code in the lexicographic ordering of geo locations that you
want the <code>ListGeoLocations</code> request to list.
</para>
<para>
Constraint: Specifying <code>SubdivisionCode</code> without <code>CountryCode</code>
returns an <a>InvalidInput</a> error.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListGeoLocationsRequest.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of geo locations you want in the response body.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListGeoLocationsResponse">
<summary>
A complex type that contains information about the geo locations that are returned
by the request and information about the response.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListGeoLocationsResponse.GeoLocationDetailsList">
<summary>
Gets and sets the property GeoLocationDetailsList.
<para>
A complex type that contains information about the geo locations that are returned
by the request.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListGeoLocationsResponse.IsTruncated">
<summary>
Gets and sets the property IsTruncated.
<para>
A flag that indicates whether there are more geo locations to be listed. If your results
were truncated, you can make a follow-up request for the next page of results by using
the values included in the <a>ListGeoLocationsResponse$NextContinentCode</a>, <a>ListGeoLocationsResponse$NextCountryCode</a>
and <a>ListGeoLocationsResponse$NextSubdivisionCode</a> elements.
</para>
<para>
Valid Values: <code>true</code> | <code>false</code>
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListGeoLocationsResponse.NextContinentCode">
<summary>
Gets and sets the property NextContinentCode.
<para>
If the results were truncated, the continent code of the next geo location in the
list. This element is present only if <a>ListGeoLocationsResponse$IsTruncated</a>
is true and the next geo location to list is a continent location.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListGeoLocationsResponse.NextCountryCode">
<summary>
Gets and sets the property NextCountryCode.
<para>
If the results were truncated, the country code of the next geo location in the list.
This element is present only if <a>ListGeoLocationsResponse$IsTruncated</a> is true
and the next geo location to list is not a continent location.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListGeoLocationsResponse.NextSubdivisionCode">
<summary>
Gets and sets the property NextSubdivisionCode.
<para>
If the results were truncated, the subdivision code of the next geo location in the
list. This element is present only if <a>ListGeoLocationsResponse$IsTruncated</a>
is true and the next geo location has a subdivision.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListGeoLocationsResponse.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of records you requested. The maximum value of <code>MaxItems</code>
is 100.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListHealthChecksRequest">
<summary>
Container for the parameters to the ListHealthChecks operation.
To retrieve a list of your health checks, send a <code>GET</code> request to the <code>2013-04-01/healthcheck</code>
resource. The response to this request includes a <code>HealthChecks</code> element
with zero, one, or multiple <code>HealthCheck</code> child elements. By default, the
list of health checks is displayed on a single page. You can control the length of
the page that is displayed by using the <code>MaxItems</code> parameter. You can use
the <code>Marker</code> parameter to control the health check that the list begins
with.
<note> Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value
greater than 100, Amazon Route 53 returns only the first 100.</note>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHealthChecksRequest.Marker">
<summary>
Gets and sets the property Marker.
<para>
If the request returned more than one page of results, submit another request and
specify the value of <code>NextMarker</code> from the last response in the <code>marker</code>
parameter to get the next page of results.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHealthChecksRequest.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
Specify the maximum number of health checks to return per page of results.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListHealthChecksResponse">
<summary>
A complex type that contains the response for the request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHealthChecksResponse.HealthChecks">
<summary>
Gets and sets the property HealthChecks.
<para>
A complex type that contains information about the health checks associated with the
current AWS account.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHealthChecksResponse.Marker">
<summary>
Gets and sets the property Marker.
<para>
If the request returned more than one page of results, submit another request and
specify the value of <code>NextMarker</code> from the last response in the <code>marker</code>
parameter to get the next page of results.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHealthChecksResponse.IsTruncated">
<summary>
Gets and sets the property IsTruncated.
<para>
A flag indicating whether there are more health checks to be listed. If your results
were truncated, you can make a follow-up request for the next page of results by using
the <code>Marker</code> element.
</para>
<para>
Valid Values: <code>true</code> | <code>false</code>
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHealthChecksResponse.NextMarker">
<summary>
Gets and sets the property NextMarker.
<para>
Indicates where to continue listing health checks. If <a>ListHealthChecksResponse$IsTruncated</a>
is <code>true</code>, make another request to <code>ListHealthChecks</code> and include
the value of the <code>NextMarker</code> element in the <code>Marker</code> element
to get the next page of results.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHealthChecksResponse.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of health checks to be included in the response body. If the number
of health checks associated with this AWS account exceeds <code>MaxItems</code>, the
value of <a>ListHealthChecksResponse$IsTruncated</a> in the response is <code>true</code>.
Call <code>ListHealthChecks</code> again and specify the value of <a>ListHealthChecksResponse$NextMarker</a>
in the <a>ListHostedZonesRequest$Marker</a> element to get the next page of results.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListHostedZonesByNameRequest">
<summary>
Container for the parameters to the ListHostedZonesByName operation.
To retrieve a list of your hosted zones in lexicographic order, send a <code>GET</code>
request to the <code>2013-04-01/hostedzonesbyname</code> resource. The response to
this request includes a <code>HostedZones</code> element with zero or more <code>HostedZone</code>
child elements lexicographically ordered by DNS name. By default, the list of hosted
zones is displayed on a single page. You can control the length of the page that is
displayed by using the <code>MaxItems</code> parameter. You can use the <code>DNSName</code>
and <code>HostedZoneId</code> parameters to control the hosted zone that the list
begins with.
<note> Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value
greater than 100, Amazon Route 53 returns only the first 100.</note>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesByNameRequest.DNSName">
<summary>
Gets and sets the property DNSName.
<para>
The first name in the lexicographic ordering of domain names that you want the <code>ListHostedZonesByNameRequest</code>
request to list.
</para>
<para>
If the request returned more than one page of results, submit another request and
specify the value of <code>NextDNSName</code> and <code>NextHostedZoneId</code> from
the last response in the <code>DNSName</code> and <code>HostedZoneId</code> parameters
to get the next page of results.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesByNameRequest.HostedZoneId">
<summary>
Gets and sets the property HostedZoneId.
<para>
If the request returned more than one page of results, submit another request and
specify the value of <code>NextDNSName</code> and <code>NextHostedZoneId</code> from
the last response in the <code>DNSName</code> and <code>HostedZoneId</code> parameters
to get the next page of results.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesByNameRequest.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
Specify the maximum number of hosted zones to return per page of results.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListHostedZonesByNameResponse">
<summary>
A complex type that contains the response for the request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesByNameResponse.HostedZones">
<summary>
Gets and sets the property HostedZones.
<para>
A complex type that contains information about the hosted zones associated with the
current AWS account.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesByNameResponse.DNSName">
<summary>
Gets and sets the property DNSName.
<para>
The <code>DNSName</code> value sent in the request.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesByNameResponse.HostedZoneId">
<summary>
Gets and sets the property HostedZoneId.
<para>
The <code>HostedZoneId</code> value sent in the request.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesByNameResponse.IsTruncated">
<summary>
Gets and sets the property IsTruncated.
<para>
A flag indicating whether there are more hosted zones to be listed. If your results
were truncated, you can make a follow-up request for the next page of results by using
the <code>NextDNSName</code> and <code>NextHostedZoneId</code> elements.
</para>
<para>
Valid Values: <code>true</code> | <code>false</code>
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesByNameResponse.NextDNSName">
<summary>
Gets and sets the property NextDNSName.
<para>
If <a>ListHostedZonesByNameResponse$IsTruncated</a> is <code>true</code>, there are
more hosted zones associated with the current AWS account. To get the next page of
results, make another request to <code>ListHostedZonesByName</code>. Specify the value
of <a>ListHostedZonesByNameResponse$NextDNSName</a> in the <a>ListHostedZonesByNameRequest$DNSName</a>
element and <a>ListHostedZonesByNameResponse$NextHostedZoneId</a> in the <a>ListHostedZonesByNameRequest$HostedZoneId</a>
element.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesByNameResponse.NextHostedZoneId">
<summary>
Gets and sets the property NextHostedZoneId.
<para>
If <a>ListHostedZonesByNameResponse$IsTruncated</a> is <code>true</code>, there are
more hosted zones associated with the current AWS account. To get the next page of
results, make another request to <code>ListHostedZonesByName</code>. Specify the value
of <a>ListHostedZonesByNameResponse$NextDNSName</a> in the <a>ListHostedZonesByNameRequest$DNSName</a>
element and <a>ListHostedZonesByNameResponse$NextHostedZoneId</a> in the <a>ListHostedZonesByNameRequest$HostedZoneId</a>
element.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesByNameResponse.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of hosted zones to be included in the response body. If the number
of hosted zones associated with this AWS account exceeds <code>MaxItems</code>, the
value of <a>ListHostedZonesByNameResponse$IsTruncated</a> in the response is <code>true</code>.
Call <code>ListHostedZonesByName</code> again and specify the value of <a>ListHostedZonesByNameResponse$NextDNSName</a>
and <a>ListHostedZonesByNameResponse$NextHostedZoneId</a> elements respectively to
get the next page of results.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListHostedZonesRequest">
<summary>
Container for the parameters to the ListHostedZones operation.
To retrieve a list of your hosted zones, send a <code>GET</code> request to the <code>2013-04-01/hostedzone</code>
resource. The response to this request includes a <code>HostedZones</code> element
with zero, one, or multiple <code>HostedZone</code> child elements. By default, the
list of hosted zones is displayed on a single page. You can control the length of
the page that is displayed by using the <code>MaxItems</code> parameter. You can use
the <code>Marker</code> parameter to control the hosted zone that the list begins
with.
<note> Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value
greater than 100, Amazon Route 53 returns only the first 100.</note>
</summary>
</member>
<member name="M:Amazon.Route53.Model.ListHostedZonesRequest.#ctor">
<summary>
Empty constructor used to set properties independently even when a simple constructor is available
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesRequest.Marker">
<summary>
Gets and sets the property Marker.
<para>
If the request returned more than one page of results, submit another request and
specify the value of <code>NextMarker</code> from the last response in the <code>marker</code>
parameter to get the next page of results.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesRequest.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
Specify the maximum number of hosted zones to return per page of results.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesRequest.DelegationSetId">
<summary>
Gets and sets the property DelegationSetId.
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListHostedZonesResponse">
<summary>
A complex type that contains the response for the request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesResponse.HostedZones">
<summary>
Gets and sets the property HostedZones.
<para>
A complex type that contains information about the hosted zones associated with the
current AWS account.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesResponse.Marker">
<summary>
Gets and sets the property Marker.
<para>
If the request returned more than one page of results, submit another request and
specify the value of <code>NextMarker</code> from the last response in the <code>marker</code>
parameter to get the next page of results.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesResponse.IsTruncated">
<summary>
Gets and sets the property IsTruncated.
<para>
A flag indicating whether there are more hosted zones to be listed. If your results
were truncated, you can make a follow-up request for the next page of results by using
the <code>Marker</code> element.
</para>
<para>
Valid Values: <code>true</code> | <code>false</code>
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesResponse.NextMarker">
<summary>
Gets and sets the property NextMarker.
<para>
Indicates where to continue listing hosted zones. If <a>ListHostedZonesResponse$IsTruncated</a>
is <code>true</code>, make another request to <code>ListHostedZones</code> and include
the value of the <code>NextMarker</code> element in the <code>Marker</code> element
to get the next page of results.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListHostedZonesResponse.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of hosted zones to be included in the response body. If the number
of hosted zones associated with this AWS account exceeds <code>MaxItems</code>, the
value of <a>ListHostedZonesResponse$IsTruncated</a> in the response is <code>true</code>.
Call <code>ListHostedZones</code> again and specify the value of <a>ListHostedZonesResponse$NextMarker</a>
in the <a>ListHostedZonesRequest$Marker</a> element to get the next page of results.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListResourceRecordSetsRequest">
<summary>
Container for the parameters to the ListResourceRecordSets operation.
Imagine all the resource record sets in a zone listed out in front of you. Imagine
them sorted lexicographically first by DNS name (with the labels reversed, like "com.amazon.www"
for example), and secondarily, lexicographically by record type. This operation retrieves
at most MaxItems resource record sets from this list, in order, starting at a position
specified by the Name and Type arguments:
<ul> <li>If both Name and Type are omitted, this means start the results at the first
RRSET in the HostedZone.</li> <li>If Name is specified but Type is omitted, this means
start the results at the first RRSET in the list whose name is greater than or equal
to Name. </li> <li>If both Name and Type are specified, this means start the results
at the first RRSET in the list whose name is greater than or equal to Name and whose
type is greater than or equal to Type.</li> <li>It is an error to specify the Type
but not the Name.</li> </ul>
<para>
Use ListResourceRecordSets to retrieve a single known record set by specifying the
record set's name and type, and setting MaxItems = 1
</para>
<para>
To retrieve all the records in a HostedZone, first pause any processes making calls
to ChangeResourceRecordSets. Initially call ListResourceRecordSets without a Name
and Type to get the first page of record sets. For subsequent calls, set Name and
Type to the NextName and NextType values returned by the previous response.
</para>
<para>
In the presence of concurrent ChangeResourceRecordSets calls, there is no consistency
of results across calls to ListResourceRecordSets. The only way to get a consistent
multi-page snapshot of all RRSETs in a zone is to stop making changes while pagination
is in progress.
</para>
<para>
However, the results from ListResourceRecordSets are consistent within a page. If
MakeChange calls are taking place concurrently, the result of each one will either
be completely visible in your results or not at all. You will not see partial changes,
or changes that do not ultimately succeed. (This follows from the fact that MakeChange
is atomic)
</para>
<para>
The results from ListResourceRecordSets are strongly consistent with ChangeResourceRecordSets.
To be precise, if a single process makes a call to ChangeResourceRecordSets and receives
a successful response, the effects of that change will be visible in a subsequent
call to ListResourceRecordSets by that process.
</para>
</summary>
</member>
<member name="M:Amazon.Route53.Model.ListResourceRecordSetsRequest.#ctor">
<summary>
Empty constructor used to set properties independently even when a simple constructor is available
</summary>
</member>
<member name="M:Amazon.Route53.Model.ListResourceRecordSetsRequest.#ctor(System.String)">
<summary>
Instantiates ListResourceRecordSetsRequest with the parameterized properties
</summary>
<param name="hostedZoneId">The ID of the hosted zone that contains the resource record sets that you want to get.</param>
</member>
<member name="P:Amazon.Route53.Model.ListResourceRecordSetsRequest.HostedZoneId">
<summary>
Gets and sets the property HostedZoneId.
<para>
The ID of the hosted zone that contains the resource record sets that you want to
get.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListResourceRecordSetsRequest.StartRecordName">
<summary>
Gets and sets the property StartRecordName.
<para>
The first name in the lexicographic ordering of domain names that you want the <code>ListResourceRecordSets</code>
request to list.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListResourceRecordSetsRequest.StartRecordType">
<summary>
Gets and sets the property StartRecordType.
<para>
The DNS type at which to begin the listing of resource record sets.
</para>
<para>
Valid values: <code>A</code> | <code>AAAA</code> | <code>CNAME</code> | <code>MX</code>
| <code>NS</code> | <code>PTR</code> | <code>SOA</code> | <code>SPF</code> | <code>SRV</code>
| <code>TXT</code>
</para>
<para>
Values for Weighted Resource Record Sets: <code>A</code> | <code>AAAA</code> | <code>CNAME</code>
| <code>TXT</code>
</para>
<para>
Values for Regional Resource Record Sets: <code>A</code> | <code>AAAA</code> | <code>CNAME</code>
| <code>TXT</code>
</para>
<para>
Values for Alias Resource Record Sets: <code>A</code> | <code>AAAA</code>
</para>
<para>
Constraint: Specifying <code>type</code> without specifying <code>name</code> returns
an <a>InvalidInput</a> error.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListResourceRecordSetsRequest.StartRecordIdentifier">
<summary>
Gets and sets the property StartRecordIdentifier.
<para>
<i>Weighted resource record sets only:</i> If results were truncated for a given DNS
name and type, specify the value of <code>ListResourceRecordSetsResponse$NextRecordIdentifier</code>
from the previous response to get the next resource record set that has the current
DNS name and type.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListResourceRecordSetsRequest.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of records you want in the response body.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListResourceRecordSetsResponse">
<summary>
A complex type that contains information about the resource record sets that are returned
by the request and information about the response.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListResourceRecordSetsResponse.ResourceRecordSets">
<summary>
Gets and sets the property ResourceRecordSets.
<para>
A complex type that contains information about the resource record sets that are returned
by the request.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListResourceRecordSetsResponse.IsTruncated">
<summary>
Gets and sets the property IsTruncated.
<para>
A flag that indicates whether there are more resource record sets to be listed. If
your results were truncated, you can make a follow-up request for the next page of
results by using the <a>ListResourceRecordSetsResponse$NextRecordName</a> element.
</para>
<para>
Valid Values: <code>true</code> | <code>false</code>
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListResourceRecordSetsResponse.NextRecordName">
<summary>
Gets and sets the property NextRecordName.
<para>
If the results were truncated, the name of the next record in the list. This element
is present only if <a>ListResourceRecordSetsResponse$IsTruncated</a> is true.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListResourceRecordSetsResponse.NextRecordType">
<summary>
Gets and sets the property NextRecordType.
<para>
If the results were truncated, the type of the next record in the list. This element
is present only if <a>ListResourceRecordSetsResponse$IsTruncated</a> is true.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListResourceRecordSetsResponse.NextRecordIdentifier">
<summary>
Gets and sets the property NextRecordIdentifier.
<para>
<i>Weighted resource record sets only:</i> If results were truncated for a given DNS
name and type, the value of <code>SetIdentifier</code> for the next resource record
set that has the current DNS name and type.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListResourceRecordSetsResponse.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of records you requested. The maximum value of <code>MaxItems</code>
is 100.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListReusableDelegationSetsRequest">
<summary>
Container for the parameters to the ListReusableDelegationSets operation.
To retrieve a list of your reusable delegation sets, send a <code>GET</code> request
to the <code>2013-04-01/delegationset</code> resource. The response to this request
includes a <code>DelegationSets</code> element with zero, one, or multiple <code>DelegationSet</code>
child elements. By default, the list of delegation sets is displayed on a single page.
You can control the length of the page that is displayed by using the <code>MaxItems</code>
parameter. You can use the <code>Marker</code> parameter to control the delegation
set that the list begins with.
<note> Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value
greater than 100, Amazon Route 53 returns only the first 100.</note>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListReusableDelegationSetsRequest.Marker">
<summary>
Gets and sets the property Marker.
<para>
If the request returned more than one page of results, submit another request and
specify the value of <code>NextMarker</code> from the last response in the <code>marker</code>
parameter to get the next page of results.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListReusableDelegationSetsRequest.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
Specify the maximum number of reusable delegation sets to return per page of results.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListReusableDelegationSetsResponse">
<summary>
A complex type that contains the response for the request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListReusableDelegationSetsResponse.DelegationSets">
<summary>
Gets and sets the property DelegationSets.
<para>
A complex type that contains information about the reusable delegation sets associated
with the current AWS account.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListReusableDelegationSetsResponse.Marker">
<summary>
Gets and sets the property Marker.
<para>
If the request returned more than one page of results, submit another request and
specify the value of <code>NextMarker</code> from the last response in the <code>marker</code>
parameter to get the next page of results.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListReusableDelegationSetsResponse.IsTruncated">
<summary>
Gets and sets the property IsTruncated.
<para>
A flag indicating whether there are more reusable delegation sets to be listed. If
your results were truncated, you can make a follow-up request for the next page of
results by using the <code>Marker</code> element.
</para>
<para>
Valid Values: <code>true</code> | <code>false</code>
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListReusableDelegationSetsResponse.NextMarker">
<summary>
Gets and sets the property NextMarker.
<para>
Indicates where to continue listing reusable delegation sets. If <a>ListReusableDelegationSetsResponse$IsTruncated</a>
is <code>true</code>, make another request to <code>ListReusableDelegationSets</code>
and include the value of the <code>NextMarker</code> element in the <code>Marker</code>
element to get the next page of results.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListReusableDelegationSetsResponse.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of reusable delegation sets to be included in the response body.
If the number of reusable delegation sets associated with this AWS account exceeds
<code>MaxItems</code>, the value of <a>ListReusablDelegationSetsResponse$IsTruncated</a>
in the response is <code>true</code>. Call <code>ListReusableDelegationSets</code>
again and specify the value of <a>ListReusableDelegationSetsResponse$NextMarker</a>
in the <a>ListReusableDelegationSetsRequest$Marker</a> element to get the next page
of results.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListTagsForResourceRequest">
<summary>
Container for the parameters to the ListTagsForResource operation.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTagsForResourceRequest.ResourceType">
<summary>
Gets and sets the property ResourceType.
<para>
The type of the resource.
</para>
<para>
- The resource type for health checks is <code>healthcheck</code>.
</para>
<para>
- The resource type for hosted zones is <code>hostedzone</code>.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTagsForResourceRequest.ResourceId">
<summary>
Gets and sets the property ResourceId.
<para>
The ID of the resource for which you want to retrieve tags.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListTagsForResourceResponse">
<summary>
A complex type containing tags for the specified resource.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTagsForResourceResponse.ResourceTagSet">
<summary>
Gets and sets the property ResourceTagSet.
<para>
A <code>ResourceTagSet</code> containing tags associated with the specified resource.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListTagsForResourcesRequest">
<summary>
Container for the parameters to the ListTagsForResources operation.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTagsForResourcesRequest.ResourceType">
<summary>
Gets and sets the property ResourceType.
<para>
The type of the resources.
</para>
<para>
- The resource type for health checks is <code>healthcheck</code>.
</para>
<para>
- The resource type for hosted zones is <code>hostedzone</code>.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTagsForResourcesRequest.ResourceIds">
<summary>
Gets and sets the property ResourceIds.
<para>
A complex type that contains the ResourceId element for each resource for which you
want to get a list of tags.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListTagsForResourcesResponse">
<summary>
A complex type containing tags for the specified resources.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTagsForResourcesResponse.ResourceTagSets">
<summary>
Gets and sets the property ResourceTagSets.
<para>
A list of <code>ResourceTagSet</code>s containing tags associated with the specified
resources.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListTrafficPoliciesRequest">
<summary>
Container for the parameters to the ListTrafficPolicies operation.
Gets information about the latest version for every traffic policy that is associated
with the current AWS account. To get the information, send a <code>GET</code> request
to the <code>2013-04-01/trafficpolicy</code> resource.
<para>
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot
of traffic policies, you can use the <code>maxitems</code> parameter to list them
in groups of up to 100.
</para>
<para>
The response includes three values that help you navigate from one group of <code>maxitems</code>
traffic policies to the next:
</para>
<ul> <li><b>IsTruncated</b></li>
<para>
If the value of <code>IsTruncated</code> in the response is <code>true</code>, there
are more traffic policies associated with the current AWS account.
</para>
<para>
If <code>IsTruncated</code> is <code>false</code>, this response includes the last
traffic policy that is associated with the current account.
</para>
<li><b>TrafficPolicyIdMarker</b></li>
<para>
If <code>IsTruncated</code> is <code>true</code>, <code>TrafficPolicyIdMarker</code>
is the ID of the first traffic policy in the next group of <code>MaxItems</code> traffic
policies. If you want to list more traffic policies, make another call to <code>ListTrafficPolicies</code>,
and specify the value of the <code>TrafficPolicyIdMarker</code> element from the response
in the <code>TrafficPolicyIdMarker</code> request parameter.
</para>
<para>
If <code>IsTruncated</code> is <code>false</code>, the <code>TrafficPolicyIdMarker</code>
element is omitted from the response.
</para>
<li><b>MaxItems</b></li>
<para>
The value that you specified for the <code>MaxItems</code> parameter in the request
that produced the current response.
</para>
</ul>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPoliciesRequest.TrafficPolicyIdMarker">
<summary>
Gets and sets the property TrafficPolicyIdMarker.
<para>
For your first request to <code>ListTrafficPolicies</code>, do not include the <code>TrafficPolicyIdMarker</code>
parameter.
</para>
<para>
If you have more traffic policies than the value of <code>MaxItems</code>, <code>ListTrafficPolicies</code>
returns only the first <code>MaxItems</code> traffic policies. To get the next group
of <code>MaxItems</code> policies, submit another request to <code>ListTrafficPolicies</code>.
For the value of <code>TrafficPolicyIdMarker</code>, specify the value of the <code>TrafficPolicyIdMarker</code>
element that was returned in the previous response.
</para>
<para>
Policies are listed in the order in which they were created.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPoliciesRequest.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of traffic policies to be included in the response body for this
request. If you have more than <code>MaxItems</code> traffic policies, the value of
the <code>IsTruncated</code> element in the response is <code>true</code>, and the
value of the <code>TrafficPolicyIdMarker</code> element is the ID of the first traffic
policy in the next group of <code>MaxItems</code> traffic policies.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListTrafficPoliciesResponse">
<summary>
A complex type that contains the response information for the request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPoliciesResponse.TrafficPolicySummaries">
<summary>
Gets and sets the property TrafficPolicySummaries.
<para>
A list that contains one <code>TrafficPolicySummary</code> element for each traffic
policy that was created by the current AWS account.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPoliciesResponse.IsTruncated">
<summary>
Gets and sets the property IsTruncated.
<para>
A flag that indicates whether there are more traffic policies to be listed. If the
response was truncated, you can get the next group of <code>MaxItems</code> traffic
policies by calling <code>ListTrafficPolicies</code> again and specifying the value
of the <code>TrafficPolicyIdMarker</code> element in the <code>TrafficPolicyIdMarker</code>
request parameter.
</para>
<para>
Valid Values: <code>true</code> | <code>false</code>
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPoliciesResponse.TrafficPolicyIdMarker">
<summary>
Gets and sets the property TrafficPolicyIdMarker.
<para>
If the value of <code>IsTruncated</code> is <code>true</code>, <code>TrafficPolicyIdMarker</code>
is the ID of the first traffic policy in the next group of <code>MaxItems</code> traffic
policies.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPoliciesResponse.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The value that you specified for the <code>MaxItems</code> parameter in the call to
<code>ListTrafficPolicies</code> that produced the current response.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneRequest">
<summary>
Container for the parameters to the ListTrafficPolicyInstancesByHostedZone operation.
Gets information about the traffic policy instances that you created in a specified
hosted zone.
<note>After you submit an <code>UpdateTrafficPolicyInstance</code> request, there's
a brief delay while Amazon Route 53 creates the resource record sets that are specified
in the traffic policy definition. For more information, see the <a>State</a> response
element.</note>
<para>
To get information about the traffic policy instances that you created in a specified
hosted zone, send a <code>GET</code> request to the <code>2013-04-01/trafficpolicyinstance</code>
resource and include the ID of the hosted zone.
</para>
<para>
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot
of traffic policy instances, you can use the <code>MaxItems</code> parameter to list
them in groups of up to 100.
</para>
<para>
The response includes four values that help you navigate from one group of <code>MaxItems</code>
traffic policy instances to the next:
</para>
<ul> <li><b>IsTruncated</b></li>
<para>
If the value of <code/>IsTruncated in the response is <code>true</code>, there are
more traffic policy instances associated with the current AWS account.
</para>
<para>
If <code>IsTruncated</code> is <code>false</code>, this response includes the last
traffic policy instance that is associated with the current account.
</para>
<li><b>MaxItems</b></li>
<para>
The value that you specified for the <code>MaxItems</code> parameter in the request
that produced the current response.
</para>
<li><b>TrafficPolicyInstanceNameMarker</b> and <b>TrafficPolicyInstanceTypeMarker</b></li>
<para>
If <code>IsTruncated</code> is <code>true</code>, these two values in the response
represent the first traffic policy instance in the next group of <code>MaxItems</code>
traffic policy instances. To list more traffic policy instances, make another call
to <code>ListTrafficPolicyInstancesByHostedZone</code>, and specify these values in
the corresponding request parameters.
</para>
<para>
If <code>IsTruncated</code> is <code>false</code>, all three elements are omitted
from the response.
</para>
</ul>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneRequest.HostedZoneId">
<summary>
Gets and sets the property HostedZoneId.
<para>
The ID of the hosted zone for which you want to list traffic policy instances.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneRequest.TrafficPolicyInstanceNameMarker">
<summary>
Gets and sets the property TrafficPolicyInstanceNameMarker.
<para>
For the first request to <code>ListTrafficPolicyInstancesByHostedZone</code>, omit
this value.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>true</code>,
<code>TrafficPolicyInstanceNameMarker</code> is the name of the first traffic policy
instance in the next group of <code>MaxItems</code> traffic policy instances.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>false</code>,
there are no more traffic policy instances to get for this hosted zone.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>false</code>,
omit this value.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneRequest.TrafficPolicyInstanceTypeMarker">
<summary>
Gets and sets the property TrafficPolicyInstanceTypeMarker.
<para>
For the first request to <code>ListTrafficPolicyInstancesByHostedZone</code>, omit
this value.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>true</code>,
<code>TrafficPolicyInstanceTypeMarker</code> is the DNS type of the first traffic
policy instance in the next group of <code>MaxItems</code> traffic policy instances.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>false</code>,
there are no more traffic policy instances to get for this hosted zone.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneRequest.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of traffic policy instances to be included in the response body
for this request. If you have more than <code>MaxItems</code> traffic policy instances,
the value of the <code>IsTruncated</code> element in the response is <code>true</code>,
and the values of <code>HostedZoneIdMarker</code>, <code>TrafficPolicyInstanceNameMarker</code>,
and <code>TrafficPolicyInstanceTypeMarker</code> represent the first traffic policy
instance in the next group of <code>MaxItems</code> traffic policy instances.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneResponse">
<summary>
A complex type that contains the response information for the request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneResponse.TrafficPolicyInstances">
<summary>
Gets and sets the property TrafficPolicyInstances.
<para>
A list that contains one <code>TrafficPolicyInstance</code> element for each traffic
policy instance that matches the elements in the request.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneResponse.TrafficPolicyInstanceNameMarker">
<summary>
Gets and sets the property TrafficPolicyInstanceNameMarker.
<para>
If <code>IsTruncated</code> is <code>true</code>, <code>TrafficPolicyInstanceNameMarker</code>
is the name of the first traffic policy instance in the next group of <code>MaxItems</code>
traffic policy instances.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneResponse.TrafficPolicyInstanceTypeMarker">
<summary>
Gets and sets the property TrafficPolicyInstanceTypeMarker.
<para>
If <code>IsTruncated</code> is true, <code>TrafficPolicyInstanceTypeMarker</code>
is the DNS type of the resource record sets that are associated with the first traffic
policy instance in the next group of <code>MaxItems</code> traffic policy instances.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneResponse.IsTruncated">
<summary>
Gets and sets the property IsTruncated.
<para>
A flag that indicates whether there are more traffic policy instances to be listed.
If the response was truncated, you can get the next group of <code>MaxItems</code>
traffic policy instances by calling <code>ListTrafficPolicyInstancesByHostedZone</code>
again and specifying the values of the <code>HostedZoneIdMarker</code>, <code>TrafficPolicyInstanceNameMarker</code>,
and <code>TrafficPolicyInstanceTypeMarker</code> elements in the corresponding request
parameters.
</para>
<para>
Valid Values: <code>true</code> | <code>false</code>
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneResponse.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The value that you specified for the <code>MaxItems</code> parameter in the call to
<code>ListTrafficPolicyInstancesByHostedZone</code> that produced the current response.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyRequest">
<summary>
Container for the parameters to the ListTrafficPolicyInstancesByPolicy operation.
Gets information about the traffic policy instances that you created by using a specify
traffic policy version.
<note>After you submit a <code>CreateTrafficPolicyInstance</code> or an <code>UpdateTrafficPolicyInstance</code>
request, there's a brief delay while Amazon Route 53 creates the resource record sets
that are specified in the traffic policy definition. For more information, see the
<a>State</a> response element.</note>
<para>
To get information about the traffic policy instances that you created by using a
specify traffic policy version, send a <code>GET</code> request to the <code>2013-04-01/trafficpolicyinstance</code>
resource and include the ID and version of the traffic policy.
</para>
<para>
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot
of traffic policy instances, you can use the <code>MaxItems</code> parameter to list
them in groups of up to 100.
</para>
<para>
The response includes five values that help you navigate from one group of <code>MaxItems</code>
traffic policy instances to the next:
</para>
<ul> <li><b>IsTruncated</b>
<para>
If the value of <code>IsTruncated</code> in the response is <code>true</code>, there
are more traffic policy instances associated with the specified traffic policy.
</para>
<para>
If <code>IsTruncated</code> is <code>false</code>, this response includes the last
traffic policy instance that is associated with the specified traffic policy.
</para>
</li> <li><b>MaxItems</b>
<para>
The value that you specified for the <code>MaxItems</code> parameter in the request
that produced the current response.
</para>
</li> <li><b>HostedZoneIdMarker</b>, <b>TrafficPolicyInstanceNameMarker</b>, and
<b>TrafficPolicyInstanceTypeMarker</b>
<para>
If <code>IsTruncated</code> is <code>true</code>, these values in the response represent
the first traffic policy instance in the next group of <code>MaxItems</code> traffic
policy instances. To list more traffic policy instances, make another call to <code>ListTrafficPolicyInstancesByPolicy</code>,
and specify these values in the corresponding request parameters.
</para>
<para>
If <code>IsTruncated</code> is <code>false</code>, all three elements are omitted
from the response.
</para>
</li> </ul>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyRequest.TrafficPolicyId">
<summary>
Gets and sets the property TrafficPolicyId.
<para>
The ID of the traffic policy for which you want to list traffic policy instances.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyRequest.TrafficPolicyVersion">
<summary>
Gets and sets the property TrafficPolicyVersion.
<para>
The version of the traffic policy for which you want to list traffic policy instances.
The version must be associated with the traffic policy that is specified by <code>TrafficPolicyId</code>.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyRequest.HostedZoneIdMarker">
<summary>
Gets and sets the property HostedZoneIdMarker.
<para>
For the first request to <code>ListTrafficPolicyInstancesByPolicy</code>, omit this
value.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>true</code>,
<code>HostedZoneIdMarker</code> is the ID of the hosted zone for the first traffic
policy instance in the next group of <code>MaxItems</code> traffic policy instances.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>false</code>,
there are no more traffic policy instances to get for this hosted zone.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>false</code>,
omit this value.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyRequest.TrafficPolicyInstanceNameMarker">
<summary>
Gets and sets the property TrafficPolicyInstanceNameMarker.
<para>
For the first request to <code>ListTrafficPolicyInstancesByPolicy</code>, omit this
value.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>true</code>,
<code>TrafficPolicyInstanceNameMarker</code> is the name of the first traffic policy
instance in the next group of <code>MaxItems</code> traffic policy instances.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>false</code>,
there are no more traffic policy instances to get for this hosted zone.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>false</code>,
omit this value.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyRequest.TrafficPolicyInstanceTypeMarker">
<summary>
Gets and sets the property TrafficPolicyInstanceTypeMarker.
<para>
For the first request to <code>ListTrafficPolicyInstancesByPolicy</code>, omit this
value.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>true</code>,
<code>TrafficPolicyInstanceTypeMarker</code> is the DNS type of the first traffic
policy instance in the next group of <code>MaxItems</code> traffic policy instances.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>false</code>,
there are no more traffic policy instances to get for this hosted zone.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyRequest.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of traffic policy instances to be included in the response body
for this request. If you have more than <code>MaxItems</code> traffic policy instances,
the value of the <code>IsTruncated</code> element in the response is <code>true</code>,
and the values of <code>HostedZoneIdMarker</code>, <code>TrafficPolicyInstanceNameMarker</code>,
and <code>TrafficPolicyInstanceTypeMarker</code> represent the first traffic policy
instance in the next group of <code>MaxItems</code> traffic policy instances.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyResponse">
<summary>
A complex type that contains the response information for the request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyResponse.TrafficPolicyInstances">
<summary>
Gets and sets the property TrafficPolicyInstances.
<para>
A list that contains one <code>TrafficPolicyInstance</code> element for each traffic
policy instance that matches the elements in the request.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyResponse.HostedZoneIdMarker">
<summary>
Gets and sets the property HostedZoneIdMarker.
<para>
If <code>IsTruncated</code> is <code>true</code>, <code>HostedZoneIdMarker</code>
is the ID of the hosted zone of the first traffic policy instance in the next group
of <code>MaxItems</code> traffic policy instances.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyResponse.TrafficPolicyInstanceNameMarker">
<summary>
Gets and sets the property TrafficPolicyInstanceNameMarker.
<para>
If <code>IsTruncated</code> is <code>true</code>, <code>TrafficPolicyInstanceNameMarker</code>
is the name of the first traffic policy instance in the next group of <code>MaxItems</code>
traffic policy instances.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyResponse.TrafficPolicyInstanceTypeMarker">
<summary>
Gets and sets the property TrafficPolicyInstanceTypeMarker.
<para>
If <code>IsTruncated</code> is <code>true</code>, <code>TrafficPolicyInstanceTypeMarker</code>
is the DNS type of the resource record sets that are associated with the first traffic
policy instance in the next group of <code>MaxItems</code> traffic policy instances.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyResponse.IsTruncated">
<summary>
Gets and sets the property IsTruncated.
<para>
A flag that indicates whether there are more traffic policy instances to be listed.
If the response was truncated, you can get the next group of <code>MaxItems</code>
traffic policy instances by calling <code>ListTrafficPolicyInstancesByPolicy</code>
again and specifying the values of the <code>HostedZoneIdMarker</code>, <code>TrafficPolicyInstanceNameMarker</code>,
and <code>TrafficPolicyInstanceTypeMarker</code> elements in the corresponding request
parameters.
</para>
<para>
Valid Values: <code>true</code> | <code>false</code>
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyResponse.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The value that you specified for the <code>MaxItems</code> parameter in the call to
<code>ListTrafficPolicyInstancesByPolicy</code> that produced the current response.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListTrafficPolicyInstancesRequest">
<summary>
Container for the parameters to the ListTrafficPolicyInstances operation.
Gets information about the traffic policy instances that you created by using the
current AWS account.
<note>After you submit an <code>UpdateTrafficPolicyInstance</code> request, there's
a brief delay while Amazon Route 53 creates the resource record sets that are specified
in the traffic policy definition. For more information, see the <a>State</a> response
element.</note>
<para>
To get information about the traffic policy instances that are associated with the
current AWS account, send a <code>GET</code> request to the <code>2013-04-01/trafficpolicyinstance</code>
resource.
</para>
<para>
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot
of traffic policy instances, you can use the <code>MaxItems</code> parameter to list
them in groups of up to 100.
</para>
<para>
The response includes five values that help you navigate from one group of <code>MaxItems</code>
traffic policy instances to the next:
</para>
<ul> <li><b>IsTruncated</b></li>
<para>
If the value of <code>IsTruncated</code> in the response is <code>true</code>, there
are more traffic policy instances associated with the current AWS account.
</para>
<para>
If <code>IsTruncated</code> is <code>false</code>, this response includes the last
traffic policy instance that is associated with the current account.
</para>
<li><b>MaxItems</b></li>
<para>
The value that you specified for the <code>MaxItems</code> parameter in the request
that produced the current response.
</para>
<li><b>HostedZoneIdMarker</b>, <b>TrafficPolicyInstanceNameMarker</b>, and <b>TrafficPolicyInstanceTypeMarker</b></li>
<para>
If <code>IsTruncated</code> is <code>true</code>, these three values in the response
represent the first traffic policy instance in the next group of <code>MaxItems</code>
traffic policy instances. To list more traffic policy instances, make another call
to <code>ListTrafficPolicyInstances</code>, and specify these values in the corresponding
request parameters.
</para>
<para>
If <code>IsTruncated</code> is <code>false</code>, all three elements are omitted
from the response.
</para>
</ul>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesRequest.HostedZoneIdMarker">
<summary>
Gets and sets the property HostedZoneIdMarker.
<para>
For the first request to <code>ListTrafficPolicyInstances</code>, omit this value.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>true</code>,
you have more traffic policy instances. To get the next group of <code>MaxItems</code>
traffic policy instances, submit another <code>ListTrafficPolicyInstances</code> request.
For the value of <code>HostedZoneIdMarker</code>, specify the value of <code>HostedZoneIdMarker</code>
from the previous response, which is the hosted zone ID of the first traffic policy
instance in the next group of <code>MaxItems</code> traffic policy instances.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>false</code>,
there are no more traffic policy instances to get.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesRequest.TrafficPolicyInstanceNameMarker">
<summary>
Gets and sets the property TrafficPolicyInstanceNameMarker.
<para>
For the first request to <code>ListTrafficPolicyInstances</code>, omit this value.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>true</code>,
<code>TrafficPolicyInstanceNameMarker</code> is the name of the first traffic policy
instance in the next group of <code>MaxItems</code> traffic policy instances.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>false</code>,
there are no more traffic policy instances to get.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesRequest.TrafficPolicyInstanceTypeMarker">
<summary>
Gets and sets the property TrafficPolicyInstanceTypeMarker.
<para>
For the first request to <code>ListTrafficPolicyInstances</code>, omit this value.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>true</code>,
<code>TrafficPolicyInstanceTypeMarker</code> is the DNS type of the first traffic
policy instance in the next group of <code>MaxItems</code> traffic policy instances.
</para>
<para>
If the value of <code>IsTruncated</code> in the previous response was <code>false</code>,
there are no more traffic policy instances to get.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesRequest.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The maximum number of traffic policy instances to be included in the response body
for this request. If you have more than <code>MaxItems</code> traffic policy instances,
the value of the <code>IsTruncated</code> element in the response is <code>true</code>,
and the values of <code>HostedZoneIdMarker</code>, <code>TrafficPolicyInstanceNameMarker</code>,
and <code>TrafficPolicyInstanceTypeMarker</code> represent the first traffic policy
instance in the next group of <code>MaxItems</code> traffic policy instances.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListTrafficPolicyInstancesResponse">
<summary>
A complex type that contains the response information for the request.
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesResponse.TrafficPolicyInstances">
<summary>
Gets and sets the property TrafficPolicyInstances.
<para>
A list that contains one <code>TrafficPolicyInstance</code> element for each traffic
policy instance that matches the elements in the request.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesResponse.HostedZoneIdMarker">
<summary>
Gets and sets the property HostedZoneIdMarker.
<para>
If <code>IsTruncated</code> is <code>true</code>, <code>HostedZoneIdMarker</code>
is the ID of the hosted zone of the first traffic policy instance in the next group
of <code>MaxItems</code> traffic policy instances.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesResponse.TrafficPolicyInstanceNameMarker">
<summary>
Gets and sets the property TrafficPolicyInstanceNameMarker.
<para>
If <code>IsTruncated</code> is <code>true</code>, <code>TrafficPolicyInstanceNameMarker</code>
is the name of the first traffic policy instance in the next group of <code>MaxItems</code>
traffic policy instances.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesResponse.TrafficPolicyInstanceTypeMarker">
<summary>
Gets and sets the property TrafficPolicyInstanceTypeMarker.
<para>
If <code>IsTruncated</code> is <code>true</code>, <code>TrafficPolicyInstanceTypeMarker</code>
is the DNS type of the resource record sets that are associated with the first traffic
policy instance in the next group of <code>MaxItems</code> traffic policy instances.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesResponse.IsTruncated">
<summary>
Gets and sets the property IsTruncated.
<para>
A flag that indicates whether there are more traffic policy instances to be listed.
If the response was truncated, you can get the next group of <code>MaxItems</code>
traffic policy instances by calling <code>ListTrafficPolicyInstances</code> again
and specifying the values of the <code>HostedZoneIdMarker</code>, <code>TrafficPolicyInstanceNameMarker</code>,
and <code>TrafficPolicyInstanceTypeMarker</code> elements in the corresponding request
parameters.
</para>
<para>
Valid Values: <code>true</code> | <code>false</code>
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyInstancesResponse.MaxItems">
<summary>
Gets and sets the property MaxItems.
<para>
The value that you specified for the <code>MaxItems</code> parameter in the call to
<code>ListTrafficPolicyInstances</code> that produced the current response.
</para>
</summary>
</member>
<member name="T:Amazon.Route53.Model.ListTrafficPolicyVersionsRequest">
<summary>
Container for the parameters to the ListTrafficPolicyVersions operation.
Gets information about all of the versions for a specified traffic policy. <code>ListTrafficPolicyVersions</code>
lists only versions that have not been deleted.
<para>
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot
of traffic policies, you can use the <code>maxitems</code> parameter to list them
in groups of up to 100.
</para>
<para>
The response includes three values that help you navigate from one group of <code>maxitems</code>maxitems
traffic policies to the next:
</para>
<ul> <li><b>IsTruncated</b></li>
<para>
If the value of <code>IsTruncated</code> in the response is <code>true</code>, there
are more traffic policy versions associated with the specified traffic policy.
</para>
<para>
If <code>IsTruncated</code> is <code>false</code>, this response includes the last
traffic policy version that is associated with the specified traffic policy.
</para>
<li><b>TrafficPolicyVersionMarker</b></li>
<para>
The ID of the next traffic policy version that is associated with the current AWS
account. If you want to list more traffic policies, make another call to <code>ListTrafficPolicyVersions</code>,
and specify the value of the <code>TrafficPolicyVersionMarker</code> element in the
<code>TrafficPolicyVersionMarker</code> request parameter.
</para>
<para>
If <code>IsTruncated</code> is <code>false</code>, Amazon Route 53 omits the <code>TrafficPolicyVersionMarker</code>
element from the response.
</para>
<li><b>MaxItems</b></li>
<para>
The value that you specified for the <code>MaxItems</code> parameter in the request
that produced the current response.
</para>
</ul>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyVersionsRequest.Id">
<summary>
Gets and sets the property Id.
<para>
Specify the value of <code>Id</code> of the traffic policy for which you want to list
all versions.
</para>
</summary>
</member>
<member name="P:Amazon.Route53.Model.ListTrafficPolicyVersionsRequest.TrafficPolicyVersionMarker">
<summary>
Gets and sets the property TrafficPolicyVersionMarker.
<para>
For your first request to <code>ListTrafficPolicyVersions</code>, do not include the
<code>TrafficPolicyVersionMarker</code> parameter.
</para>
<para>
If you have more traffic policy versions than the value of <code>MaxItems</code>,
<code>ListTrafficPolicyVersions</code> returns only the first group of <code>MaxItems</code>
versions. To get the next group of <code>MaxItems</code> traffic policy versions,
submit another request to <code>ListTrafficPolicyVersions</code>. For the value of